/scribus-plugin-API

Primary LanguageC++GNU General Public License v2.0GPL-2.0

scribus-plugin-API

A stable, high level and documented interface to the Scribus core that plugin developers can use to access the Scribus features.

Install

Clone the scribus-plugin-API repository and put – or symlink – its src directory into scribus/plugins/ as scribusAPI. Then add

ADD_SUBDIRECTORY(scribusAPI)

to CMakeList.txt file in scribus/plugins/.

You will need a compiler that defaults to C++11 or enable C++11 in your cmake command.

In the Getting started manual for Scribus developers, you'll find more in details instructions.

Roadmap

  • setup the plugin
  • activate a first class and method and try to call it from another plugin
  • add lot of doxygen comments
    • each file
    • each class
    • each public method
  • use namespaces
  • setup a documentation framework (probably QDoc)
  • move the epub's plugin ScribusDocument class to the ScribusAPI
  • make more publicity for this project and find out how to improve its architecture / add more coverage of Scribus features.

Doxygen documentation

We have a Doxygen documentation of the code:

http://impagina.org/dox/api/

The documentation can by running (at the root of this repository):

doxygen documentation/config.doxygen

to create the html documentation in the documentation directory.

You can enable, generate and use the latex files to then create a Pdf version of the documentation with pdflatex.

Notes

  • find a way to allow versioning of the API and, eventually, allow multiple version to be installed side to side. (or provide compatibility calls in new versions of the API, since we want the people to use the current API, if possible)

  • check with the team: http://voices.canonical.com/jussi.pakkanen/2013/03/26/a-list-of-common-cmake-antipatterns/

      Using add_dependencies

  This one is simple. Say you have code such as this:

  target_link_libraries(myexe mylibrary)
  add_dependencies(myexe mylibrary)
  The second line is unnecessary. CMake knows there is a dependency between the two just based
  on the first line. There is no need to say it again, so the second line can be deleted.

  Add_dependencies is only required in certain rare and exceptional circumstances.