home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 December / PCWorld_2000-12_cd.bin / Komunikace / Comanche / help / notes.txt < prev   
Text File  |  2000-11-02  |  1KB  |  58 lines
  1.  
  2. HTML -> tidy -> XML -> tcl script -> several small html pieces
  3.  
  4.  
  5. XML -> HTML pieces
  6.  
  7. Each piece is stored:
  8.  
  9. modName/directiveName.html
  10.  
  11.  
  12. In the HTML, links to other directives are substituted with [command showHelp $module $name]
  13. Links to external resources are also provided.
  14.  
  15.  
  16. ---------
  17.  
  18. Parser
  19.  
  20. Outline:
  21. --------
  22.  
  23. For each directive (a directive is delimited betweenn <H2> with id and <hr>):
  24.       - Strip html from links in status, default and context.
  25.       - Substitute <a href> to internal links to help elements or external links
  26.  
  27. Save into file
  28.  
  29.  
  30. ---------
  31.  
  32. GUI
  33.  
  34. User wants to:
  35. - Look up directives by name
  36. - Show several directives at once (when pointed from property page)
  37. - Show modules introduction
  38. - Show other HTML documents
  39.  
  40. To be implemented
  41. - Search directives by content in the name
  42. - Autocompletion when looking for directives
  43.  
  44.  
  45. UI design
  46.  
  47.  
  48. ------------
  49. |    |     | 
  50. | 1  |  2  |
  51. ------------
  52.  
  53. 2 -> Where to display HTML
  54. 1 -> two paned, one a tree pane structured by module and then by directive
  55.      Only one directive at the beginning and at the top also a combobox
  56.  
  57. No directive help is stored in memory help, they al always read from disk.
  58.