).First, you need to create an API type include function that should be created as an include PHP page. Users of phpMyFAQ would then add this page in all of the pages that they create. Example:
require_once($PathLevel."_include/phpmyfaq-functions.inc");
This allows the developers to integrate the glossary seamlessly into their current sites.
Oh, and we also need a drop-in function that allows a "site search" to be added by the developers to thier pages.
Second, within this API include page there would be a function that could be used to perform the look-up and rendering of the required links and word. Example:
This page is a summary of the <?php DefinedWord("SETI@Home Project"); ?> with links out to the science information that is developed as a consequence of the processing performed by the <?php DefinedWord("participants"); ?>.
This PHP page would give rendered HTML as:
This page is a summary of the <a href="../../site-common/glossary/letter-s.php#seti@home-project">SETI@Home Project</a> with links out to the science information that is developed as a consequence of the processing performed by the <a href="../../site-common/glossary/letter-p.php#participant">participants</a>.
Of course, this is rendered as it would be for my static glossary, yours would be rendered as needed to allow the clicking on the link to transport the user to the appropriate page to display the definition. As a novice in PHP I have nary a clue as how that could be made effective.
Third, as an option, or as a natural course of events, a complete static rendering of the glossary database contents should be generated so that browsing of the complete glossary is possible. Note that this output should be on a alphabetic sort with separate pages for each initial letter.
Fourth, the glossary would be seemlessly integrated into current keyword system so that the designation of a defined word within the FAQ text would not only add the link into the glossary it would make this part of the currrent search system, and the search would also add to the returned FAQ links the link into the glossary.
Fifth the editor would have a keyword action that would perform an "autotag" of the first occurance of the keywords within the text of the new FAQ topic. Note this would start with the longest possible defined "words" (phrases actually) and find the most specific designation. In the example given above, autotag would tag "SETI@Home Project" even though definitions are available for each of the individual terms (the glossary contains: SETI@Home, project, SETI@Home Project). Autotag only needs to target the first occurrance of each defined word within the text.
Sixth the glossary needs to be able to include an "Also see: " list so that other pages external to the glossary and FAQ can be rendered along with the definitions returned by searches. Oh, yes; the "Also see: " list should include a listing of the FAQ entries that contain the reference term. I would suggest that these be separated into two hidden lists that are sortable by relevance and number of hits, etc. so that the user can quickly goto the most useful places within the site.
edit:
the seach should use "soundex" searching so mispellings are also answered.
end edit
You have probably thought of all of these, or someone else has already suggested them, however, I cannot speak or read German ... so I decided, what the heck!
If any of this does not make sense, I can try to explain what the heck I mean ...