Sugar on a Stick/Documentation SOP: Difference between revisions

Newer edit →

@@ Line 13: / Line 13: @@
 * Bump the edition tag in ''Book_Info.xml'' after a major change.
 * Make sure to explain your change in Revision_History.xml
+=== Generating HTML or PDF output ===
+Install publican if you haven't already. On most Linux distributions, this will be:
+ sudo yum install publican
+In the same directory as the file '''''publican.cfg''''' (this will almost certainly be '''''/path/to/soas-docs/Customization Guide''''' or '''''/path/to/soas-docs/Creation Kit'''''), run the following command.
+ publican build --format=html --lang=en-US
+or
+ publican build --format=pdf --lang=en-US
+...depending on what output format you would like. You will see output that looks like this.
+<pre>
+[you@machine]$ publican build --format=html --lang=en-US
+Setting up en-US
+        Processing file tmp/en-US/xml/Common_Content/Conventions.xml
+        Processing file tmp/en-US/xml/Common_Content/Feedback.xml
+        Processing file tmp/en-US/xml/Common_Content/Legal_Notice.xml
+        <snip more similar stuff>
+Beginning work on en-US
+        Starting html
+        Using XML::LibXSLT on /usr/share/publican/xsl/html.xsl
+Writing pref-Customization_Guide-Preface.html for preface(pref-Customization_Guide-Preface)
+Writing sect-Creation_Kit-Preparation-Getting_Started.html for section(sect-Creation_Kit-Preparation-Getting_Started)
+Writing chap-Customization_Guide-Preparation.html for chapter(chap-Customization_Guide-Preparation)
+<snip more similar stuff>
+Writing index.html for book
+        Finished html
+</pre>
+When the publican build is finished, you will find your generated docs in a folder called '''''tmp/en-US''''' in your current directory.
 === Create a Patch from your Changes ===