next up previous
Next: 9. Printing quality - Up: A Short Beginner-User's Guide Previous: 7. Cross References

   
8. Transportability of the document

Usually, the documentation source file will be prepared and maintained in a directory under the author's $HOME directory, while the HTML version of the documentation (i.e. all the files.html" etc...) will be hosted at any other place, possibly on another machine.

The transport of the HTML document will be made by copying the files from the origin place to the new place on the new machine.

In this respect, it is important to make sure that the paths indicated to define the links remain valid at the new location.

This will be the case if RELATIVE paths are exclusively used to define these links. We saw above that HTML starting from a source file file.tex", creates a directory file" at the level immediately under. This directory will be referred to as "HTML document directory".

The simplest way to insure transportability is to put all the information concerning the HTML document in this "HTML document directory", and to use for the links only the name of the files without any path (since they are physically in the same directory).


If a more subtle architecture is planned (e.g. creation of a sub-directory figs for the figures, or so), then the links relative to the figures should have the form figs/figureXX.html (symmetrically, directories at an higher level can be accessed by the relative path syntax "..").

If a directory architecture is used instead of the simpler architecture with only one level, the transport of the document would obviously have to respect the directory architecture.


next up previous
Next: 9. Printing quality - Up: A Short Beginner-User's Guide Previous: 7. Cross References
Pierre BENARD
2002-06-19