source: branches/properties/HELP_SOURCE/help.readme

Last change on this file was 18781, checked in by westram, 3 years ago
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 1.1 KB
Line 
1
2ARB documentation
3-----------------
4
5    Sources for ARB helpfiles are located in 'HELP_SOURCE/source'.
6
7    They contain plain text which is converted into .xml and
8    stored in 'HELP_SOURCE/Xml'.
9
10    These .xml files are converted into
11    - Hypertext (stored in 'lib/help_html') and
12    - Arb helpfiles (stored in 'lib/help')
13
14    The difference between the original helpfiles
15    from 'HELP_SOURCE/source' and the resulting ones
16    in 'lib/help' is the formatting.
17
18
19    The ARB software displays the helpfiles located in 'lib/help'.
20    When you press the 'BROWSE' button, it displays those in 'lib/help_html'.
21
22    The latter is also made available at http://help.arb-home.de/arb.html
23    (updates from trunk every 24h)
24
25
26    When editing helpfiles from inside the ARB software, it depends
27    on DEBUG mode, what happens:
28    - with DEBUG mode enable this edits the files in 'HELP_SOURCE/source'
29      (if they are available)
30    - in userland it edits the files in 'HELP_SOURCE/source'. After editing the
31      changes are packed into an archive (ready to be sent to arb developers).
Note: See TracBrowser for help on using the repository browser.