daCode documentation
Users documentation

 Menu
 · Contents
 · Using this doc
 · User's guide


Contents
   You will find here all documents destined to the readers of a site using daCode. You probably will not need it, but your users may. The main document is the user's guide, a short guide describing how to use the most common features of daCode.

Using this doc
   If you think your readers will need it, you will surely have to adapt it to you particular setup. The user's guide is written for the LinuxFR theme, and some themes have very different layouts. You may also have added or removed some features from daCode.

   You have three ways to adapt it:
  • the first is to simply copy the passages which interess you into you own document;
  • you may also edit the HTML version with your favorite HTML editor;
  • or you may edit the XML source.
The latter is the best and more flexible way, as it will allow you to retain your changes as new versions of this guide appear. But there are some limitations:
  • you will some tool to convert Docbook XML to HTML (with jade for example);
  • you need Perl to generate the real XML file (you need to run scripts/doctranslator.pl to convert the multilingual XML file into a valid, one language XML file);
  • customizing the output is not as easy as using a WYSIWYG editor.
As I said, the main XML file is multilingual, with the following format: everything between <:lg and :> is kept only in the lg translation. Everything outside <:?? and :> is kept in every translation (mostly markup). lg stands for a particular language two-letter code (e.g. "en", "fr" or "es"), while ?? stands for any two-letter sequence.