Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml,v diff -u -r1.4.2.1 -r1.4.2.2 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml 19 Nov 2003 14:35:15 -0000 1.4.2.1 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-advanced.xml 15 Dec 2003 14:18:48 -0000 1.4.2.2 @@ -61,11 +61,11 @@ pre-written documentation files for the tutorial app. Log in as service0, create the standard directories, and copy the prepared documentation: - [service0@yourserver service0]$ cd /var/lib/aolserver/service0/packages/samplenote/ -[service0@yourserver samplenote]$ mkdir -p www/doc/xml -[service0@yourserver samplenote]$ cd www/doc/xml -[service0@yourserver xml]$ cp /var/lib/aolserver/service0/packages/acs-core-docs/www/files/samplenote/* . -[service0@yourserver xml]$ + [service0 service0]$ cd /var/lib/aolserver/service0/packages/samplenote/ +[service0 samplenote]$ mkdir -p www/doc/xml +[service0 samplenote]$ cd www/doc/xml +[service0 xml]$ cp /var/lib/aolserver/service0/packages/acs-core-docs/www/files/samplenote/* . +[service0 xml]$ OpenACS uses DocBook for documentation. DocBook is an XML standard for semantic markup of documentation. That means that the tags you use indicate meaning, not intended @@ -86,7 +86,7 @@ directory. A Makefile is provided to generate html from the xml, and copy all of the supporting files. If Docbook is set up correctly, all you need to do is: - [service0@yourserver xml]$ make + [service0 xml]$ make cd .. ; /usr/bin/xsltproc ../../../acs-core-docs/www/xml/openacs.xsl xml/index.xml Writing requirements-introduction.html for sect1(requirements-introduction) Writing requirements-overview.html for sect1(requirements-overview) @@ -102,7 +102,7 @@ Writing admin-guide.html for chapter(admin-guide) Writing bi01.html for bibliography Writing index.html for book -[service0@yourserver xml]$ +[service0 xml]$ Verify that the documentation was generated and reflects your changes by browsing to http://yoursite:8000/samplenote/doc @@ -114,20 +114,20 @@ traverse the directory tree manually and add as you go. (More on CVS) - [service0@yourserver xml]$ cd .. -[service0@yourserver doc]$ cd .. -[service0@yourserver www]$ cd .. -[service0@yourserver samplenote]$ cd .. -[service0@yourserver packages]$ cvs add samplenote/ + [service0 xml]$ cd .. +[service0 doc]$ cd .. +[service0 www]$ cd .. +[service0 samplenote]$ cd .. +[service0 packages]$ cvs add samplenote/ Directory /cvsroot/service0/packages/samplenote added to the repository -[service0@yourserver packages]$ cd samplenote/ -[service0@yourserver samplenote]$ cvs add www +[service0 packages]$ cd samplenote/ +[service0 samplenote]$ cvs add www Directory /cvsroot/service0/packages/samplenote/www added to the repository -[service0@yourserver samplenote]$ cd www -[service0@yourserver www]$ cvs add doc +[service0 samplenote]$ cd www +[service0 www]$ cvs add doc Directory /cvsroot/service0/packages/samplenote/www/doc added to the repository -[service0@yourserver www]$ cd doc -[service0@yourserver doc]$ cvs add * +[service0 www]$ cd doc +[service0 doc]$ cvs add * cvs add: cannot add special file `CVS'; skipping cvs add: scheduling file `admin-guide.html' for addition cvs add: scheduling file `bi01.html' for addition @@ -152,13 +152,13 @@ cvs add: scheduling file `user-interface.png' for addition Directory /cvsroot/service0/packages/samplenote/www/doc/xml added to the repository cvs add: use 'cvs commit' to add these files permanently -[service0@yourserver doc]$ cd xml -[service0@yourserver xml]$ cvs add Makefile index.xml +[service0 doc]$ cd xml +[service0 xml]$ cvs add Makefile index.xml cvs add: scheduling file `Makefile' for addition cvs add: scheduling file `index.xml' for addition cvs add: use 'cvs commit' to add these files permanently -[service0@yourserver xml]$ cd ../../.. -[service0@yourserver samplenote]$ cvs commit -m "new package" +[service0 xml]$ cd ../../.. +[service0 samplenote]$ cvs commit -m "new package" cvs commit: Examining . cvs commit: Examining www cvs commit: Examining www/doc @@ -170,7 +170,7 @@ initial revision: 1.1 done (many lines omitted) -[service0@yourserver samplenote]$ +[service0 samplenote]$ Delete with confirmation @@ -179,7 +179,7 @@ Add this column to the table_def in index.tcl {delete "" {} {<td><a href="note-delete?note_id=$note_id">Delete</a></td>}} Create the delete confirmation/execution page. - [service0@yourserver www]$ emacs note-delete.tcl + [service0 www]$ emacs note-delete.tcl ad_page_contract { A page that gets confirmation and then delete notes. @@ -224,7 +224,7 @@ script execution. The database commands: - [service0@yourserver www]$ emacs note-delete.xql + [service0 www]$ emacs note-delete.xql <?xml version="1.0"?> <queryset> <fullquery name="do_delete"> @@ -239,7 +239,7 @@ </fullquery> </queryset> And the adp page: - [service0@yourserver www]$ emacs note-delete.adp + [service0 www]$ emacs note-delete.adp <master> <property name="title">@title@</property> <property name="context">{@title@}</property>