GSoC 2011 Scripter2 Proposal: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
(Created page with "Category:GSOC_2011 = Enhancing ScripterNG in Scribus = == Abstract == Scribus shows that professional desktop publishing is possible with Free Software. Scribus has many po...")
 
(→‎Useful Links.: link to gsoc2008)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:GSOC_2011]]
[[Category:GSOC_2011]]
= Enhancing ScripterNG in Scribus =
= Enhancing Scripting Engine 'scripter2' in Scribus =
 


== Abstract ==  
== Abstract ==  
Scribus shows that professional desktop publishing is possible with Free Software. Scribus has many powerful features which are often mentioned in articles, eg. high quality PDF export and color management. But, its scripting features are not getting attention even after the complete redesign of its architecture.Scribus has a well designed API for its new ScripterNG, developed as part of GSoC 2008. But, this new generation scripter still lacks functionalities which are present in its old scripter. One of the main goals of this project is to port the complete API of old scripter to the ScripterNG so that any existing scripts developed for old scripter should be usable in ScripterNG, without any changes.
 
Scribus shows that professional desktop publishing is possible with Free Software. Scribus has many powerful features which are often mentioned in articles. For instance, high quality PDF export and color management are considered to be the strong points of Scribus. However, the scripting features of Scribus are not getting attention even after the complete redesign of its architecture even though analysis of the user mailing list postings shows that the scripted use of Scribus's features is on a constant rise and is a critical functionality for many professional users.
 
Scribus has a well designed API for its new ScripterNG also known as scripter2, developed as part of GSoC 2008. This scripting engine can also be adapted to multiple scripting languages. However, the scripter2 still does not expose many of the Scribus API calls present in the old scripter1. One of the main goals of this project is to port the complete API of the old scripter to the scripter2 for retaining the backwards compatibility and providing complete API coverage needed for the deprecation of scripter1 and the switch to scripter2.


== Problem Description ==
== Problem Description ==


The new ScripterNG in Scribus has not been added as a default feature in Scribus due to lack of functionalities in it. As compared to its old scripter, the new scripter has less number of Scribus API functions supported in it. For eg, Styles API is missing it ScripterNG, hence user is unable to handle styles using scripts. createParagraphStyle and createCharacterStyle were present in scripter1, but it is missing in ScripterNG. Here is a long list of changes which are yet to be implemented in ScripterNG : - http://wiki.scribus.net/canvas/ScripterNG/Development/PortingOldScripter - http://wiki.scribus.net/canvas/ScripterNG/Development#API_ideas_.2F_missing_APIsThis project will complete the porting of Old Scripter to ScripterNG, so that it may be used as the default scripter in Scribus.== Implementation Plan ==Implementation of this project will be based on the well-known software engineering principle, [http://en.wikipedia.org/wiki/Test-driven_development Test-driven Development]. All those scripts that are packaged with Scribus is tested with the new ScripterNG, and development proceeds by solving all those issues which encounter while testing them. All scripts those bundled with Scribus were developed based on Scripter1. This development process will also help to make the Scribus API better, since there exist more chances for some code refactoring. === Deliverables ===* Support for complete Scripter1 API in ScripterNG.** Reference : [http://wiki.scribus.net/canvas/ScripterNG/Development/PortingOldScripter Porting Old Scripter] by Henning== Timeline ====== First week ====* Setting up the infrastructure like blog/wiki, code repository etc.* Getting additional feedback from developers and from the community about the project.==== Week 2-3 ====* Testing out scripts available and analysis of needed changes to be implemented* Documentation of changes==== Until 11th of July ====* Porting features from old Scripter, listed in the reference link.* Implement most needed API features before midterm evaluation.** Discussions with development team regarding those features to be implemented before midterm evaluations==== Until 15th of July ====Writing mid-term evaluation==== Until 10th of August ====* Further improving the ScripterNG API by adding all the features left, after the midterm evaluations* Writing sample scripts, for unit tests.** Each and every function ported to new Scripter will be tested.==== Until 15th of August ====* Fixing bugs* Reviewing and improving usability* Writing documentations** User documentation for each function, quoting the sample scripts** Developer Documentation.==== Until 26th of august ('pencils down') ====Preparations for Final Evaluation== Student Biography ==I am Jain Basil Aliyas, a computer science & engineering student from India. I am one among the members of Scribus team, KDE and Pardus Projects.== Contact Information =='''Name''' : Jain Basil Aliyas'''Country''' : India  '''Time Zone''' : GMT +530'''IRC Nickname''' : jainbasil in #scribus, #scribus-dev== Useful Links. == - http://wiki.scribus.net/canvas/ScripterNG/Development/PortingOldScripter - http://wiki.scribus.net/canvas/ScripterNG/Development
The new scripter2 has not been added to Scribus as a default scripting engine even though it was developed back in 2008 because its Scribus API coverage is still below that of scripter1. For instance, Styles API is missing in scripter2. Hence, users are unable to handle Scribus styles in their scripts. In addition, createParagraphStyle and createCharacterStyle were present in scripter1, but missing in scripter2.  
 
Here is a long list of changes which are yet to be implemented in ScripterNG :  
 
* http://wiki.scribus.net/canvas/ScripterNG/Development/PortingOldScripter
* http://wiki.scribus.net/canvas/ScripterNG/Development#API_ideas_.2F_missing_APIs
 
This project will complete the porting of scripter1 scripting engine to scripter2, so that much improved scripter2 may be used as the default scripting engine in Scribus.
 
== Implementation Plan ==
 
Implementation of this project will be based on a well-known software engineering principle [http://en.wikipedia.org/wiki/Test-driven_development Test-driven Development]. All scripts packaged with Scribus will be tested with scripter2, and development will proceed by solving all issues encountered in the testing. All scripts bundled with Scribus were developed based on scripter1, so they can be used for testing scripter2. This development process will also help to make the Scribus API better, since opportunities for code refactoring may be discovered in the process.  
 
=== Deliverables ===
 
* Support for complete Scripter1 API in Scripter2.
* Deprecation of Scripter1.
* Completion of Scribus C++ API coverage in Scripter2.
** Reference : [http://wiki.scribus.net/canvas/ScripterNG/Development/PortingOldScripter Porting Old Scripter] by Henning
 
== Timeline ==
 
==== April 23 - May 5 ====
* Setting up the infrastructure i.e. code repository, blog for progress reporting and so on.
* Getting additional feedback on the project from Scribus developers and the community.
* Discussing the most requested missing APIs to build a list of features to be implemented before midterm evaluations.
 
==== May 6 - May 23 ====
* Testing bundled and user contributed scripts, analyzing the results, and determining what changes need to be implemented.
* Documenting changes as the new scripter API using reSt in docstrings and a scripted documentation extraction to be formatted with Sphynx.
 
==== May 24 - July 11 ====
* Porting APIs from scripter1 to scripter2.
** Implement most needed missing APIs before the midterm evaluation.
 
==== July 12 - July 15 ====
Writing mid-term evaluation
==== July 16 - August 10 ====
 
* Further improving the Scripter2 API by completing the coverage of the Scribus C++ classes beyond scripter1.
* Writing sample scripts for unit tests.
** Every function ported to the new Scripter will be tested.
 
==== August 11 - August 15 ====
* Fixing bugs discovered in the testing process.
* Reviewing and improving API usability based on user feedback.
* Writing documentation.
** User documentation for each function with examples.
** Developer documentation for the scripting engine.
 
==== August 16 - August 26 ('pencils down') ====
Preparing for the final evaluation.
 
== Personal Information ==
 
I am Jain Basil Aliyas a computer science & engineering student from India.
 
== Contact Information ==
 
'''Name''' : Jain Basil Aliyas
 
'''Country''' : India   
 
'''Time Zone''' : GMT +530
 
'''IRC Nickname''' : jainbasil in #scribus, #scribus-dev
 
== Useful Links. ==
* Archives
  - http://wiki.scribus.net/canvas/GSoC_2008_ScripterNG : first GSOC project and scripter2 concepts
 
* Development
  - http://wiki.scribus.net/canvas/ScripterNG/Development/PortingOldScripter
  - http://wiki.scribus.net/canvas/ScripterNG/Development
* Documentation
  - http://jainbasil.net/Scribus/Python/2012/07/scripter-documentation-readthedocs-disqus/
  - http://scribus-scripter.readthedocs.org/en/latest/

Latest revision as of 20:55, 22 October 2013

Enhancing Scripting Engine 'scripter2' in Scribus

Abstract

Scribus shows that professional desktop publishing is possible with Free Software. Scribus has many powerful features which are often mentioned in articles. For instance, high quality PDF export and color management are considered to be the strong points of Scribus. However, the scripting features of Scribus are not getting attention even after the complete redesign of its architecture even though analysis of the user mailing list postings shows that the scripted use of Scribus's features is on a constant rise and is a critical functionality for many professional users.

Scribus has a well designed API for its new ScripterNG also known as scripter2, developed as part of GSoC 2008. This scripting engine can also be adapted to multiple scripting languages. However, the scripter2 still does not expose many of the Scribus API calls present in the old scripter1. One of the main goals of this project is to port the complete API of the old scripter to the scripter2 for retaining the backwards compatibility and providing complete API coverage needed for the deprecation of scripter1 and the switch to scripter2.

Problem Description

The new scripter2 has not been added to Scribus as a default scripting engine even though it was developed back in 2008 because its Scribus API coverage is still below that of scripter1. For instance, Styles API is missing in scripter2. Hence, users are unable to handle Scribus styles in their scripts. In addition, createParagraphStyle and createCharacterStyle were present in scripter1, but missing in scripter2.

Here is a long list of changes which are yet to be implemented in ScripterNG :

This project will complete the porting of scripter1 scripting engine to scripter2, so that much improved scripter2 may be used as the default scripting engine in Scribus.

Implementation Plan

Implementation of this project will be based on a well-known software engineering principle Test-driven Development. All scripts packaged with Scribus will be tested with scripter2, and development will proceed by solving all issues encountered in the testing. All scripts bundled with Scribus were developed based on scripter1, so they can be used for testing scripter2. This development process will also help to make the Scribus API better, since opportunities for code refactoring may be discovered in the process.

Deliverables

  • Support for complete Scripter1 API in Scripter2.
  • Deprecation of Scripter1.
  • Completion of Scribus C++ API coverage in Scripter2.

Timeline

April 23 - May 5

  • Setting up the infrastructure i.e. code repository, blog for progress reporting and so on.
  • Getting additional feedback on the project from Scribus developers and the community.
  • Discussing the most requested missing APIs to build a list of features to be implemented before midterm evaluations.

May 6 - May 23

  • Testing bundled and user contributed scripts, analyzing the results, and determining what changes need to be implemented.
  • Documenting changes as the new scripter API using reSt in docstrings and a scripted documentation extraction to be formatted with Sphynx.

May 24 - July 11

  • Porting APIs from scripter1 to scripter2.
    • Implement most needed missing APIs before the midterm evaluation.

July 12 - July 15

Writing mid-term evaluation

July 16 - August 10

  • Further improving the Scripter2 API by completing the coverage of the Scribus C++ classes beyond scripter1.
  • Writing sample scripts for unit tests.
    • Every function ported to the new Scripter will be tested.

August 11 - August 15

  • Fixing bugs discovered in the testing process.
  • Reviewing and improving API usability based on user feedback.
  • Writing documentation.
    • User documentation for each function with examples.
    • Developer documentation for the scripting engine.

August 16 - August 26 ('pencils down')

Preparing for the final evaluation.

Personal Information

I am Jain Basil Aliyas a computer science & engineering student from India.

Contact Information

Name : Jain Basil Aliyas

Country : India

Time Zone : GMT +530

IRC Nickname : jainbasil in #scribus, #scribus-dev

Useful Links.

  • Archives
 - http://wiki.scribus.net/canvas/GSoC_2008_ScripterNG : first GSOC project and scripter2 concepts
  • Development
 - http://wiki.scribus.net/canvas/ScripterNG/Development/PortingOldScripter
 - http://wiki.scribus.net/canvas/ScripterNG/Development
  • Documentation
 - http://jainbasil.net/Scribus/Python/2012/07/scripter-documentation-readthedocs-disqus/
 - http://scribus-scripter.readthedocs.org/en/latest/