diff options
| author | Stefan Kost <ensonic@users.sourceforge.net> | 2006-02-02 11:24:19 +0000 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sourceforge.net> | 2006-02-02 11:24:19 +0000 |
| commit | 523041b5331a3a54cc49dd6f7f39608bf2f328e2 (patch) | |
| tree | 749c11c21a7934efc342ab13f92e4f7bdc6643a8 /docs/README | |
| parent | cefc46ad7e6374565ddebe6663ae80a83fb04c03 (diff) | |
docs/: describe dparams (controller) for plugins unify docs a little more
Original commit message from CVS:
* docs/README:
* docs/manual/intro-basics.xml:
* docs/manual/intro-preface.xml:
* docs/manual/manual.xml:
* docs/pwg/advanced-dparams.xml:
* docs/pwg/intro-basics.xml:
* docs/pwg/intro-preface.xml:
* docs/pwg/pwg.xml:
describe dparams (controller) for plugins
unify docs a little more
Diffstat (limited to 'docs/README')
| -rw-r--r-- | docs/README | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/README b/docs/README index 68d5a2178..8a0dc3866 100644 --- a/docs/README +++ b/docs/README @@ -40,6 +40,9 @@ We stick to some simple conventions for writing docbook documentation. - sections should also include the chapter name; for example in a chapter called chapter-example, a section would be called section-example-hello-world +* there are currently comments of the form <!-- synchronize with PWG --> + in the docbook file. Please check the relevant section of the other manual + when updating. HOW IMAGES ARE HANDLED ---------------------- @@ -86,11 +89,9 @@ HOW THE BUILD SYSTEM IS SET UP * html is built in a subdir, with the png/ps images copied there * ps and pdf are built in the current dir, in one file - -DOCBOOK NOTES -============= - -* spell checking with aspell +SPELL CHECKING +-------------- +* with aspell * aspell -b -c --mode=sgml --lang=en <file>.xml unfortunately the curses-ui of aspell (0.50.5) has problems with the xml tags |