twostones   software   yads  yads

apuntes
articles
books
guests
whoami
software

index

  


The Short Introduction to Yads

Yads converts a set of XML files to ascii, HTML, Perl CGI's, or LaTeX. Functionality is provided to define other text-based output formats without touching the Perl code. Documents can be static, or can embed Perl or Python code in them to produce dynamic documents. It can be run on a single file, or on a set of related files to produce a full web, or a complex, multi-chapter PDF document. When output is HTML (and Perl CGI's) it provides navigational aids, like an automatically generated web map, list of nodes higher up in the web hierarchy, and more.


The Manual

  1. The long introduction to Yads.
  2. The Programs:

    1. yads is the main program.
    2. mktree is used to build a tree file from a given directory structure.
    3. getdoc extracts the XML embedded in program comments.

  3. Using Yads.
  4. Default Configuration Files:

    1. defs-eng.xml is the default definitions file for normal (yadsdoc) documents.
    2. defs-man.xml is the definitions file used by yadsman, the document type used to add XML comments to program source code.

   Yads is the Yads Advanced Documentation System (although it used to be Yet Another Documentation System).  


 
Last modified 13 April 2001 HTML generated by yads