Readme for the Dynamic-Index Project
System requirements: IE5 or higher with MSXML3.0 installed.
Demo: To get an idea what's the Dynamic Index project is all about, try the XSLT Reference or the SAS Documentation examples.
The Index isn't static! Try opening one of the info sheets in notepad (either those under /XSLT Reference or /SAS Doc) and play with the classification instructions. No matter if you delete,
change or even add a classifying element of your own, the index will immediately reflect this once you re-compile it! Unlike any "hardtyped" TOCs or Indexes that need to be manually updated every once in a
while, the Dynamic Index is constantly synchronized with the docs, being merely a form of presentation, yet not that of a single file but of a whole set of documents.
Technical info: The XML element that registers a document in a certain hierarchy is:
<classify by = "hierarchy-name"
type1 = "key-1"
type2 = "key-2"
. . .
typeN = "key-N">
[ optional text that replaces the automatic description retrieved
from the /doc/purpose section of the document]
</classify>
For example:
<classify by = "Grandma's recipes"
type1 = "desserts"
type2 = "pies"
type3 = "apple pie" />
Please note:
- A classifying instruction may be placed anywhere in the document, and you can have as many different ones as you'd like.
- You can register the same document into the same hierarchy several times, each time in a different place
- The compiler is case- and space- sensitive, meaning that
type1="function"
and type1="FUNCTION"
are considered as two different categories
Use the Dynamic Index Wizard (DI-wizard.hta) when you have finished classifying your documents to create an index containing all the resulting hierarchies. Opening the index file in Internet Explorer will launch the viewer in which you can browse the trees, switching from one to another using the tabs at the top.
Finally, remember to re-compile the index every time you want to synchronize it with the docs. It doesn't matter if you do it frequently to see the immediate changes you make to every single doc, or if you do it in the end when all pre-classifying is already done.
Known Bugs/Problems:
1. Avoid using apostrophes (" , ') in hierarchy names, this will confuse the viewer program.
2. If your antivirus software complains or tries to block the compiler, you'll need to temporarily pause it.