Mailing List Archive: 49091 messages
  • Home
  • Script library
  • AltME Archive
  • Mailing list
  • Articles Index
  • Site search

[REBOL] RFC: make-doc-pro feature / glossary

From: robert::muench::robertmuench::de at: 5-Jun-2002 14:55

Hi, I'm thinking about adding a glossary function to MDP. There are several possibilities to implement such a function. The goal is that glossary words will display the glossary description of the mouse is moved over the word. I want to use the <DFN> HTML tag for this. I'm not sure which version is most pratical for the user: 1. Explicit marking the words with ?gloassary-word? Result: For all words marked with ? make-doc-pro would make a look up in a text file and include the definition into the output. Advantages: - Esay to implement - Simple usage - User can decide where to include glossary output and where not Disadvantages: - If you want the glossary term for all the same words, you have to wrap them all in ? sequence. 2. Explicit marking of words with ?glossary-word? once Result: Same as 1. but now make-doc-pro would include the glossary definition for all appearances of the word. Advantages: - User only has to mark the word once in a file. Disadvantages: - If the glossary text is long, it will be included several times into the HTML output. (Is there a trick to reference such text-blocks in HTML?) 3. Explicit marking of all words found in glossary Result: make-doc-pro uses the glossary file and just includes the description for all words that are found in the glossary. Advantages: - No markup needed for the user. - Can simple be turned on off. Disadvantages: - Same as 2. What do you think? Which version is most useful for you? Do you have any other ideas how to handle such a functionality? Robert