GSoC 2011 Scripter2 Proposal

From Scribus Wiki
Jump to: navigation, search

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/