ScripterNG/Development

From Scribus Wiki
Jump to navigation Jump to search

Development on the new scripter

Documentation

  • How does the core (connecting Python to C++) work?
  • How can I add new functions?
  • How do I port code from older scripter to the new one?


Ideas for scripts and extensions

Requirements to implement above scripts

  • call gettext importer api
  • call pdf exporter
  • event hooks (selection changed, document changed,
  • access to (de)saxe api to (de)serialize pageitems
  • access to StoryText object

API ideas / missing APIs

  • Layers
    • activeDocument.layers / activeDocument.activeLayer (property)
      • layer.{visible, active, print, lock} (bool property)
      • layer.remove()
    • item.sentToLayer(layer_name)
    • activeDocument.newLayer(..)
  • Colors
    • activeDocument.colors (str list propery)
    • activeDocument.activeColor (property)
    • activeDocument.newColor(..)
  • Fonts
    • Scripter.{fontNames, xfontNames} (str list property)
    • Scripter.renderFont(..)
  • Guides
    • activePage.{horizontalGuides, verticalGuides} (double property list)
  • Selections
  • Text
  • Styles
  • Selections / Groups
  • GUI
    • Scripter.dialogs.valueInput
    • Scripter.dialogs.{openFilename, saveFilename, openDirectory}
    • Scripter.activeWindow.progess
    • Scripter.activeWindow.mouseCursorType
  • Misc
    • activeDocument.importPage
    • MasterPage-stuff
    • PageItem-Proxy: Currently a script can directly access a PageItem. It would be better if there is a thin layer between them.

Other important TODO

  • add i18n and integrate with rest of Scribus

Implementation of other scripting languages (must be platform-neutral)

  • Perl
  • Ruby
  • JavaScript/QtScript
  • Lua

Links

(will lookup my bookmarks)