Writing Documentation for ArtiSynth

Contents

• 1 Introduction
• 2 How Documents Are Created
  • 2.1 Document Source Code Organization
  • 2.2 Makefile commands to build documents
    • 2.2.1 Javadocs
    • 2.2.2 HTML files
    • 2.2.3 PDF files
    • 2.2.4 Other Commands
  • 2.3 Building single HTML files
  • 2.4 Building sectioned HTML files
  • 2.5 Building PDF files
  • 2.6 Installing Documents on the Webserver
• 3 LaTeX usage and conventions
  • 3.1 LaTeXML restrictions
  • 3.2 Font conventions
  • 3.3 Code blocks
  • 3.4 Side blocks
  • 3.5 Inserting Images
  • 3.6 Javadoc References
    • 3.6.1 Class references
    • 3.6.2 Method references
    • 3.6.3 How it works
  • 3.7 References to other ArtiSynth documents
• 4 Adding a New Document
  • 4.1 Creating and Updating the Makefiles
  • 4.2 Updating the InfoCenter
  • 4.3 Updating the ArtiSynth website
• 5 Images, IDraw and Xfig
• 6 Eclipse InfoCenter
• 7 External Software Required
  • 7.1 Installing LaTeXML
• 8 Local Customizations
  • 8.1 setJavadocLinks script
  • 8.2 fixLatexmlOutput script