This is to unify all the ML informations into a unique collaborative manual.
In the official ML repository there is the official manual. It's located here :
https://bitbucket.org/hudson/magic-lantern/src/tip/doc/This is in different pieces: txt's, png's, bmp's, jpg's, drawings and so on. They are all organized into a precise structure, with chapters and so on, and this structures is as follows (but changes continuously as the manual develops) :
include(o, "FEATURES.txt");
include(o, "MANUAL.txt", 1);
include(o, "MENUSTART.txt");
include(o, "MN-AUDIO.txt");
include(o, "MN-EXPO.txt");
include(o, "MN-OVERLAY.txt");
include(o, "MN-MOVIE.txt");
include(o, "MN-SHOOT.txt");
include(o, "MN-FOCUS.txt");
include(o, "MN-DISPLAY.txt");
include(o, "MN-PREFS.txt");
include(o, "MN-DEBUG.txt");
include(o, "MENUEND.txt");
include_indent(o, "FAQ.txt");
This structure is controlled by scripts, so you can add chapters to it. All the scripts are in the doc directory (mkdoc.py is for pdf, mkdoc-cam for help bmp's, wikidoc for wiki output - but needs some tweaks). You need latex to compile them.
Each TXT file is plain text, you can edit it online, or offline and then commit it. The syntax is RST (
http://docutils.sourceforge.net/docs/user/rst/quickstart.html) and can contain references to images (living in the same directory of the txt) in this way :
.. figure:: 02.expo.png
:align: center
:width: 5cm
To add images, commit them like normal files to the official ML repository.
You can add files, sections, whatever.
The good of this system, is that, by modifying this manual, it's modified the help PDF in the nightly builds, it's modified the BMP ML help system inside the cameras and, if anyone fixes the wiki scripts, we can update the online version as well, all from a single source !
