| Prev | Chapter�10.�Advanced Topics | Next |
|---|
It's time to document. For the tutorial we'll use +
Before you get started you should make yourself familiar with + the tags that are used to write your documentation. For tips on + editing SGML files in emacs, see OpenACS Documentation Guide.
It's time to document. For the tutorial we'll use pre-written documentation. When creating a package from scratch, start by copying the documentation template from /var/lib/aolserver/openacs-dev/packages/acs-core-docs/xml/docs/xml/package-documentation-template.xml @@ -25,8 +27,7 @@ <revhistory>). Add a new record to the document version history. Look for the <authorgroup> tag and - add yourself as a second author. Save and exit. For tips on - editing SGML files in emacs, see OpenACS Documentation Guide
Process the xml file to create html documentation. The + add yourself as a second author. Save and exit.
Process the xml file to create html documentation. The html documentation, including supporting files such as pictures, is stored in the www/docs/ directory. A Makefile is provided to generate html from the xml, and copy all of the @@ -48,4 +49,4 @@ Writing bi01.html for bibliography Writing index.html for book [service0 xml]$
Verify that the documentation was generated and reflects - your changes by browsing to http://yoursite:8000/myfirstpackage/doc