Index: openacs-4/packages/acs-core-docs/www/xml/engineering-standards/docbook-primer.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/engineering-standards/docbook-primer.xml,v diff -u -N -r1.14 -r1.15 --- openacs-4/packages/acs-core-docs/www/xml/engineering-standards/docbook-primer.xml 11 Dec 2010 23:36:32 -0000 1.14 +++ openacs-4/packages/acs-core-docs/www/xml/engineering-standards/docbook-primer.xml 7 Aug 2017 23:47:54 -0000 1.15 @@ -24,7 +24,7 @@ The history of OpenACS documentation: ..began by - building on a good documentation base from ArsDigita's ACS in the + building on a good documentation base from ArsDigita's ACS in the late 1990's. Some sections of the documentation, however, lacked details and examples; others simply did not exist. The OpenACS community began meeting the challenge by identifying needs and @@ -53,7 +53,7 @@ developers had to learn the system through experience with working with it and discussion in the forums. Informal sharing of experiential and tacit knowledge has become the OpenACS - community's main method of sharing knowledge. + community's main method of sharing knowledge. This document attempts to shape ongoing documentation efforts by @@ -225,7 +225,7 @@ documentation is organized. - The use licenses between OpenACS and Arsdigita's ACS are not + The use licenses between OpenACS and Arsdigita's ACS are not compatible, thereby creating strict limits on how much OpenACS developers should have access to Arsdigita code and resources. The OpenACS documentation has a new legal @@ -422,8 +422,8 @@ Create a long bulleted list of features. Feature list should go deeper than high-level feature lists and look at the - quality of the implementations (from the user's perspective, - not the programmer's). Example issues an end-user may have + quality of the implementations (from the user's perspective, + not the programmer's). Example issues an end-user may have questions about: Ticket Tracker and Ticket Tracker Lite, why would I want one of them vs the other? And, before I specify to download and install it, what credit card gateways are @@ -476,7 +476,7 @@ Create a list of administrative tools that are useful to administrating OpenACS, including developer support, - schema-browser and api browser. Link to AOLserver's config + schema-browser and api browser. Link to AOLserver's config file documentation. @@ -554,7 +554,7 @@ list critical decisions (perhaps as questions) that need to - be made before starting: which OS, which DB, which aolserver + be made before starting: which OS, which DB, which AOLserver version, system name, dependencies et cetera. Maybe summarize options as tables or decision-trees. For example, "As you proceed throughout the installation, you will be acting on @@ -610,7 +610,7 @@ Provide working examples that highlight the various - subsystems, tcl environment, OpenACS protocols, aolserver + subsystems, Tcl environment, OpenACS protocols, AOLserver template and ns_* commands, OpenACS templating, sql queries, db triggers, scheduling protocols, how to use the page contract, how to get the accessing user_id etc @@ -697,7 +697,7 @@ Add overview diagrams showing the core parts of the - datamodel including an updated summary of Greenspun's + datamodel including an updated summary of Greenspun's Chapter 4: Data Models and the Object System @@ -800,12 +800,11 @@ It is open-source. - A growing community surrounds DocBook (has - mailing lists) + The DocBook community mailing lists A number of free and commercial - tools are available + tools are available for editing and publishing DocBook documents. @@ -834,7 +833,7 @@ XML does not require extra effort. Writing in XML is almost identical to SGML, with a couple extra rules. More details in the - LDP Author Guide. + LDP Author Guide. The tool chain has matured. xsltproc and other XML @@ -868,7 +867,7 @@ The following DocBook primer walks you through the basics, and should cover the - needs for 95 percent of the documentation we produce. You are welcome to explore DocBook's + needs for 95 percent of the documentation we produce. You are welcome to explore DocBook's list of elements and use more exotic features in your documents. The list is made up of SGML-elements but basically @@ -921,7 +920,7 @@ XSL Stylesheets (docbook-xsl) - The stylesheets to convert to HTML. We have been using a stylesheet based upon - NWalsh's chunk.xsl. + NWalsh's chunk.xsl. @@ -939,9 +938,9 @@ Some editing tool. A popular one is Emacs with the psgml and nXML modes. The LDP Author + url="http://www.tldp.org/LDP/LDP-Author-Guide/html/index.html">LDP Author Guide and DocBook + url="https://github.com/docbook/wiki/wiki/DocBookTools">DocBook Wiki list some alternates. @@ -962,7 +961,7 @@ You can look at some templates for documents (in Docbook XML) in the sources + url="https://github.com/openacs/openacs-core/tree/oacs-5-9/packages/acs-core-docs/www/xml/engineering-standards">sources for acs-core-docs, especially the Detailed Design Documentation Template and the System/Application Requirements Template. @@ -991,7 +990,7 @@ | +--sect2 : Sections - functional requirements | - +--sect3 : Subsections - Programmer's API + +--sect3 : Subsections - Programmer's API | ... : ... @@ -1003,7 +1002,7 @@ and we will provide a set of templates for documenting an entire package. For now you can take a look at the - sources of these DocBook documents + sources of these DocBook documents to get an idea of how they are tied together. @@ -1024,7 +1023,7 @@ id, is standard and can be used with all elements. It comes in very handy when interlinking between documents (more about this when talking about links in ). The value of id has to be unique - throughout the book you're making since the id's in your + throughout the book you're making since the id's in your sect1's will turn into filenames when the book is parsed into HTML. @@ -1036,7 +1035,7 @@ Right after the opening tag you put the title of the document - this is usually the same as - xreflabel-attribute. E.g. the top level of the document you're + xreflabel-attribute. E.g. the top level of the document you're reading right now looks like this: @@ -1104,7 +1103,7 @@ Linking - Linking falls into two different categories: inside the book you're making and outside: + Linking falls into two different categories: inside the book you're making and outside: @@ -1117,7 +1116,7 @@ with a simple tag, regardless of where that part is. - xreflinkendCheck out how I link to a subsection of the Developer's Guide: + xreflinkendCheck out how I link to a subsection of the Developer's Guide: Put this in your XML: @@ -1152,7 +1151,7 @@ - If the section you link to hasn't a specified xreflabel-attribute, + If the section you link to hasn't a specified xreflabel-attribute, the link is going to look like this: @@ -1171,7 +1170,7 @@ - Note that since I haven't provided an xreflabel for the subsection, + Note that since I haven't provided an xreflabel for the subsection, packages-looks, the parser will try its best to explain where the link takes you. @@ -1184,7 +1183,7 @@ 2. Linking outside the documentation ulink - If you're hyper-linking out of the documentation, it works almost the same way as HTML - the tag is just + If you're hyper-linking out of the documentation, it works almost the same way as HTML - the tag is just a little different (<ulink>): @@ -1261,7 +1260,7 @@ lists - Here's how you make the DocBook equivalent of the three usual HTML-lists: + Here's how you make the DocBook equivalent of the three usual HTML-lists: @@ -1311,7 +1310,7 @@ 3. How to make a <dl> - This kind of list is called a variablelist and these are the tags you'll need to + This kind of list is called a variablelist and these are the tags you'll need to make it happen: <variablelist>, <varlistentry>, @@ -1430,7 +1429,7 @@ - The <emphasis> tag defaults to italics when parsed. If you're looking for + The <emphasis> tag defaults to italics when parsed. If you're looking for emphasizing with bold type, use <emphasis role="strong">. @@ -1486,7 +1485,7 @@ - This example uses Daniel Veillard's xsltproc command available as part of libxslt from http://www.xmlsoft.org/XSLT/. @@ -1506,7 +1505,7 @@ - You could also look at the acs-core-docs Makefile + You could also look at the acs-core-docs Makefile for examples of how these documents are generated. @@ -1522,7 +1521,7 @@ The LDP Author + url="http://www.tldp.org/LDP/LDP-Author-Guide/html/index.html">LDP Author Guide has a lot of good information, a table of docbook elements and their "look" in HTML and lots of good links for tools. @@ -1539,7 +1538,7 @@ wrote an intro to the PSGML Mode in Emacs - James Clark's free Java parser + James Clark's free Java parser XP. Note that this does not validate XML, only parses it. @@ -1562,7 +1561,7 @@ In the process of transforming your HTML into XML, HTML tidy - can be a handy tool to make your HTML "regexp'able". + can be a handy tool to make your HTML "regexp'able". Brandoch Calef has made a Perl