TDE core libraries
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

81 lines
3.9 KiB

  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. * DocBook
  32. - Tidy up the DTD
  33. - introduce a versioning system (and scripts to generate the Makefile.ams)
  34. - write style checker
  35. + redo the declarations following the example NW gave for qandasets
  36. (that may simplify the redeclaration files a lot)
  37. - set up scheme for upgrading the DTD. If restrictions are
  38. introduced, the number must go up by one. Every doc should get
  39. highest version against which its validates. New docs should take
  40. the current version.
  41. (script that checks and updates DTD FPIs in documentation; script
  42. that checks when a DTD FPI is not needed anymore; script that
  43. validates all documents in a tree and records the errors somewhere;
  44. put DTDs on line) What about file naming conventions for versions
  45. (so that they can be re-used) - automatic checking from source tree:
  46. translations should only be told off when there is a difference with
  47. the English source of the same version.
  48. - mediaobject should always be accompanied by a text alternative
  49. - fixe role list for othercredit
  50. * Other
  51. - make clear: indexterm use (so that index can be activated)
  52. - anchors can be requested by programmers (change as little as possible)
  53. - guidelines/checker
  54. - different types of links and targets
  55. - make clear other functionality can be requested by documentation writers (eg
  56. line numbering, etc.)
  57. - Provide info for Postscript (and source code) (with link?)
  58. - consider format script and all options, ... in SGML file (~ DB-CDROM)
  59. - create tool that builds graphics library (and a catalog in the same dir)
  60. (use pngmeta-1.10 to find the sizes)
  61. - create scripts for catalog files and document entities
  62. - Language specific parts in document (eg links to dictionaries etc should be
  63. done with an entity), eg in Translation howto
  64. - Write FPI script (for external references).
  65. - decide on distinction notice and full license (and adapt files
  66. accordingly)
  67. - CSS: position graphics centered or let text flow around them
  68. - reorganize DTDs such that independent parts are really independent
  69. and have their own catalogues. That should make versioning easier.
  70. Versioning should happen with subdirectories that contain the files
  71. of a given version, until that one is used no longer in the
  72. documentation. (write script to check that)
  73. * Meaning of characters:
  74. `*' indicates a TODO item
  75. `-' indicates a TODO subitem, no action taken
  76. `+' indicates a TODO subitem, some action was taken, but not finished
  77. Finished items are removed