Privacy Policy
This shows you the differences between two versions of the page.
| — |
knowhow:documentation [2009/11/28 04:48] (current) Tomas Straupis created |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | TOra documentation is currently used for help system only. In the future it will also be used to generate one documentation book (one pdf file). | ||
| + | == Files == | ||
| + | |||
| + | Help files are currently held in three places: | ||
| + | * ///tora/doc/help// | ||
| + | * ///tora/src/help// | ||
| + | * ///tora-htdocs/help// | ||
| + | |||
| + | "Main" place for help documents is ///tora/doc/help//. It is here where files should be modified. Second and third place is actually just a symbolic link to the first one. | ||
| + | |||
| + | == Creating == | ||
| + | |||
| + | Help information should be updated in //texi// files and not directly in //html// files (unless there is no corresponding //texi// file). **Note** that //index.html// file is built automatically! | ||
| + | |||
| + | //Toc.html// file is the first one displayed after choosing Help->Contents in TOra. That file should be modified manually if new chapters are added or deprecated ones are removed. | ||
| + | |||
| + | After adding or removing help files or pictures, do not forget to update ///src/tora.qrc// file. | ||