kdoctools/TODO

   1 * Style sheets
   2 - check interpretation of generated keywords in HTML
   3 + crystal clear documentation: where does the code come from and how was it
   4   modified, what were the reasons for it. (in which case the structure of the
   5   files does not need to be similar)
   6 + fix ALT= and </P> problems: Will happen when mediaobject is used instead of
   7   graphic and when the library is used.  The </P> problem is unsolved as yet,
   8   but patched in the CSS style sheets.
   9 - othercredit: translators should be inserted
  10   author/authorgroup: what it says
  11   contrib: contributors to the *text*
  12   othercredit: translators and proofreaders
  13   Distinction should be made between text and software (and indicated)
  14   ChangeLog: in reference doc and ChangeLog file - not in documentation
  15   Translators can change: lang attribute in top element, id attribute in all
  16   but anchors, othercredits: add translators and contributors to translation
  17   RevHistory: changes to the text(!)
  18 - abstract: make more clear from layout (?)
  19 - make list of authors/contributors from code, and put them at the back of the
  20   document if html, at the front on verso if printed
  21 - decide on swapover date for patches (and make old version available)
  22 - make script that allows to check if entities are out of date (*.dsl is too
  23   hard) from English
  24 - investigate olinks
  25 - Add language to link to chunk is that it is different (both in HTML
  26   and in the visible text)
  27 - check changes with new versions of style sheets
  28 - maintenance dsl (for web pages)
  29 - fpi dsl
  30 - Fix RFC1766 problem
  31
  32 * DocBook
  33 - Tidy up the DTD
  34 - introduce a versioning system (and scripts to generate the Makefile.ams)
  35 - write style checker
  36 + redo the declarations following the example NW gave for qandasets
  37   (that may simplify the redeclaration files a lot)
  38 - set up scheme for upgrading the DTD.  If restrictions are
  39   introduced, the number must go up by one.  Every doc should get
  40   highest version against which its validates.  New docs should take
  41   the current version.
  42   (script that checks and updates DTD FPIs in documentation; script
  43   that checks when a DTD FPI is not needed anymore; script that
  44   validates all documents in a tree and records the errors somewhere;
  45   put DTDs on line)  What about file naming conventions for versions
  46   (so that they can be re-used) - automatic checking from source tree:
  47   translations should only be told off when there is a difference with
  48   the English source of the same version.
  49 - mediaobject should always be accompanied by a text alternative
  50 - fixe role list for othercredit
  51
  52 * Other
  53 - make clear: indexterm use (so that index can be activated)
  54 - anchors can be requested by programmers (change as little as possible)
  55 - guidelines/checker
  56 - different types of links and targets
  57 - make clear other functionality can be requested by documentation writers (eg
  58   line numbering, etc.)
  59 - Provide info for Postscript (and source code) (with link?)
  60 - consider format script and all options, ... in SGML file (~ DB-CDROM)
  61 - create tool that builds graphics library (and a catalog in the same dir)
  62   (use pngmeta-1.10 to find the sizes)
  63 - create scripts for catalog files and document entities
  64 - Language specific parts in document (eg links to dictionaries etc should be
  65   done with an entity), eg in Translation howto
  66 - Write FPI script (for external references).
  67 - decide on distinction notice and full license (and adapt files
  68   accordingly)
  69 - CSS: position graphics centered or let text flow around them
  70 - reorganize DTDs such that independent parts are really independent
  71   and have their own catalogs.  That should make versioning easier.
  72   Versioning should happen with subdirectories that contain the files
  73   of a given version, until that one is used no longer in the
  74   documentation.  (write script to check that)
  75
  76 * Meaning of characters:
  77  `*' indicates a TODO item
  78  `-' indicates a TODO subitem, no action taken
  79  `+' indicates a TODO subitem, some action was taken, but not finished
  80  Finished items are removed