WysiwygDocumentation

bdbaddog edited this page Sep 1, 2017 · 4 revisions

WYSIWYG Editing for SCons Documentation

Editing single chapters

The DocBook source files for the User Guide have been set up in a way, such that you can either load the whole document ("main.xml"), or a single chapter file like "libraries.xml" for example.

The latter option is to be preferred, since it doesn't require as much CPU and memory for rendering the documents live.

Insertion of DTD entities

After adding a new Tool, Builder or something like this, you'll have to update the list of generated entities by calling

  python bin/docs-update-generated.py

Only after this step will you be able to insert and use the newly added entities in all the single chapters and the global document "main.xml".

Configurations for visual editing

Configuration sets for two visual XML editors have been prepared. These are **XmlMind** and Syntext Serna, both offering good WYSIWYG like editing. Other, more text-oriented solutions like Editix or Quanta may be used with success too (check the list of DocBook Authoring tools for an exhaustive list).

Finally, I also found Howto create a visual Docbook Editor in 10 Minutes, a short description about how to use the VPE/JBOSS plugin of Eclipse to preview XML documents. But I did not follow this route any further...any volunteers out there?

XMLMind editor

Homepage : http://www.xmlmind.com/xmleditor

Tested versions : Professional Edition 5.8.1

This editor comes also in a free version, containing all the basic features that you'll need for editing DocBook documents. Unfortunately, this Personal Edition doesn't support user-defined target namespaces. So you'll have to invest a few bucks, but it's definitely worth the money in my opinion.

Copy the contents of the "xmlmind" folder in the archive to your user's XXE config directory. This is located at

  • "$HOME/.xxe4/" on Linux.

  • "$HOME/Library/Application Support/XMLmind/XMLEditor4/" on the Mac.

  • %APPDATA%\XMLmind\XMLEditor4\ on Windows 2000, XP, Vista. for the versions of XXE with a major version number of 4. Later versions with a 5.x are using

  • "$HOME/.xxe5/" on Linux,

  • "$HOME/Library/Application Support/XMLmind/XMLEditor5/" on the Mac and

  • %APPDATA%\XMLmind\XMLEditor5\ on Windows 2000, XP, Vista. After a restart of the program, the SCons DTD is picked up automatically, and you can even select it when inserting new Books, Articles,... whatever.

xmlmind Screenshot

Syntext Serna Free

Homepage : http://sourceforge.net/projects/sernafree.mirror

Tested version : 4.4.0

This is a good alternative to the XmlMind editor, however its "Insert tag" philosophy didn't convince me that much. But your mileage may vary... After Serna was bought by another company, the free version won't get developed any further unfortunately. But it's still okay for basic writing stuff as in the SCons docs, so give it a spin.

Copy the prepared "scons" addon folder to the "plugins" directory of your Serna installation. Depending on where and how you installed the program, you might need root access for this step.

Serna Screenshot

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.