[Swift-commit] r5033 - in branches/release-0.93/docs: . documentation
davidk at ci.uchicago.edu
davidk at ci.uchicago.edu
Wed Aug 31 12:37:41 CDT 2011
Author: davidk
Date: 2011-08-31 12:37:41 -0500 (Wed, 31 Aug 2011)
New Revision: 5033
Added:
branches/release-0.93/docs/documentation/
branches/release-0.93/docs/documentation/automation
branches/release-0.93/docs/documentation/building
branches/release-0.93/docs/documentation/building.html
branches/release-0.93/docs/documentation/documentation.txt
branches/release-0.93/docs/documentation/overview
branches/release-0.93/docs/documentation/structure
Log:
Description of how the new documentation system works
Added: branches/release-0.93/docs/documentation/automation
===================================================================
--- branches/release-0.93/docs/documentation/automation (rev 0)
+++ branches/release-0.93/docs/documentation/automation 2011-08-31 17:37:41 UTC (rev 5033)
@@ -0,0 +1,26 @@
+Document Automation
+-------------------
+All .txt files in the docs directory get converted to HTML and PDF on a nightly
+basis. These documents then get copied to the Swift web site.
+
+Cron Job
+~~~~~~~~
+The job that processes these documents runs on Bridled at 7pm nightly. The script is
+/home/davidk/docscripts/update_and_build.sh. The script calls svn update on several
+different swift directories in ~davidk, and then builds the the documents. The
+documents should be built for each Swift branch later than 0.93, including trunk. As
+new versions of Swift are created, this script will need to be updated.
+
+Website
+-------
+Once the cron job runs, documents can be accessed at:
+
+\http://www.ci.uchicago.edu/swift/guides/release-<version>/documentname/documentname.html
+\http://www.ci.uchicago.edu/swift/guides/release-<version>/documentname/documentname.pdf
+
+For example, assume that you create a document called docs/newdoc. You check this
+guide into Swift 0.93. The AsciiDoc .txt file is called newdoc.txt. The URLs
+that would be generated would be:
+
+\http://www.ci.uchicago.edu/swift/guides/release-0.93/newdoc/newdoc.html
+\http://www.ci.uchicago.edu/swift/guides/release-0.93/newdoc/newdoc.pdf
Added: branches/release-0.93/docs/documentation/building
===================================================================
--- branches/release-0.93/docs/documentation/building (rev 0)
+++ branches/release-0.93/docs/documentation/building 2011-08-31 17:37:41 UTC (rev 5033)
@@ -0,0 +1,26 @@
+Building Documentation Manually
+-------------------------------
+Before committing anything to SVN, it is a good idea manually
+build the documentation for testing purposes.
+
+Prerequisites
+~~~~~~~~~~~~~
+There are several prerequisites for building documentation:
+
+* asciidoc and a2x (http://www.methods.co.nz/asciidoc)
+* dblatex (http://dblatex.sourceforge.net)
+* source-highlight (http://www.gnu.org/software/src-highlite)
+
+For CI users, compiled versions of these packages can be found in ~davidk.
+
+build_docs.sh
+~~~~~~~~~~~~~
+
+The script to build the documentation is docs/build_docs.sh. This script
+will convert the documents into HTML and PDF, and then copy the
+files to a given output directory.
+
+.Usage
+-----
+./build_docs.sh /path/to/copy/output
+-----
Added: branches/release-0.93/docs/documentation/building.html
===================================================================
--- branches/release-0.93/docs/documentation/building.html (rev 0)
+++ branches/release-0.93/docs/documentation/building.html 2011-08-31 17:37:41 UTC (rev 5033)
@@ -0,0 +1,576 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.6.3" />
+<title></title>
+<style type="text/css">
+/* Sans-serif font. */
+h1, h2, h3, h4, h5, h6,
+div.title, caption.title,
+thead, p.table.header,
+div#toctitle,
+span#author, span#revnumber, span#revdate, span#revremark,
+div#footer {
+ font-family: Arial,Helvetica,sans-serif;
+}
+
+/* Serif font. */
+div.sectionbody {
+ font-family: Georgia,"Times New Roman",Times,serif;
+}
+
+/* Monospace font. */
+tt {
+ font-size: inherit;
+}
+
+body {
+ margin: 1em 5% 1em 5%;
+}
+
+a {
+ color: blue;
+ text-decoration: underline;
+}
+a:visited {
+ color: fuchsia;
+}
+
+em {
+ font-style: italic;
+ color: navy;
+}
+
+strong {
+ font-weight: bold;
+ color: #083194;
+}
+
+tt {
+ font-size: inherit;
+ color: navy;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: #527bbd;
+ margin-top: 1.2em;
+ margin-bottom: 0.5em;
+ line-height: 1.3;
+}
+
+h1, h2, h3 {
+ border-bottom: 2px solid silver;
+}
+h2 {
+ padding-top: 0.5em;
+}
+h3 {
+ float: left;
+}
+h3 + * {
+ clear: left;
+}
+
+div.sectionbody {
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+ul, ol, li > p {
+ margin-top: 0;
+}
+ul > li { color: #aaa; }
+ul > li > * { color: black; }
+
+pre {
+ padding: 0;
+ margin: 0;
+}
+
+span#author {
+ color: #527bbd;
+ font-weight: bold;
+ font-size: 1.1em;
+}
+span#email {
+}
+span#revnumber, span#revdate, span#revremark {
+}
+
+div#footer {
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+div#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+div#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+div#preamble {
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+ margin-top: 1.0em;
+ margin-bottom: 1.5em;
+}
+div.admonitionblock {
+ margin-top: 2.0em;
+ margin-bottom: 2.0em;
+ margin-right: 10%;
+ color: #606060;
+}
+
+div.content { /* Block element content. */
+ padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+ color: #527bbd;
+ font-weight: bold;
+ text-align: left;
+ margin-top: 1.0em;
+ margin-bottom: 0.5em;
+}
+div.title + * {
+ margin-top: 0;
+}
+
+td div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content + div.title {
+ margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+ background: #ffffee;
+ border: 1px solid #dddddd;
+ border-left: 4px solid #f0f0f0;
+ padding: 0.5em;
+}
+
+div.listingblock > div.content {
+ border: 1px solid #dddddd;
+ border-left: 5px solid #f0f0f0;
+ background: #f8f8f8;
+ padding: 0.5em;
+}
+
+div.quoteblock, div.verseblock {
+ padding-left: 1.0em;
+ margin-left: 1.0em;
+ margin-right: 10%;
+ border-left: 5px solid #f0f0f0;
+ color: #777777;
+}
+
+div.quoteblock > div.attribution {
+ padding-top: 0.5em;
+ text-align: right;
+}
+
+div.verseblock > pre.content {
+ font-family: inherit;
+ font-size: inherit;
+}
+div.verseblock > div.attribution {
+ padding-top: 0.75em;
+ text-align: left;
+}
+/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
+div.verseblock + div.attribution {
+ text-align: left;
+}
+
+div.admonitionblock .icon {
+ vertical-align: top;
+ font-size: 1.1em;
+ font-weight: bold;
+ text-decoration: underline;
+ color: #527bbd;
+ padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+ padding-left: 0.5em;
+ border-left: 3px solid #dddddd;
+}
+
+div.exampleblock > div.content {
+ border-left: 3px solid #dddddd;
+ padding-left: 0.5em;
+}
+
+div.imageblock div.content { padding-left: 0; }
+span.image img { border-style: none; }
+a.image:visited { color: white; }
+
+dl {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+dt {
+ margin-top: 0.5em;
+ margin-bottom: 0;
+ font-style: normal;
+ color: navy;
+}
+dd > *:first-child {
+ margin-top: 0.1em;
+}
+
+ul, ol {
+ list-style-position: outside;
+}
+ol.arabic {
+ list-style-type: decimal;
+}
+ol.loweralpha {
+ list-style-type: lower-alpha;
+}
+ol.upperalpha {
+ list-style-type: upper-alpha;
+}
+ol.lowerroman {
+ list-style-type: lower-roman;
+}
+ol.upperroman {
+ list-style-type: upper-roman;
+}
+
+div.compact ul, div.compact ol,
+div.compact p, div.compact p,
+div.compact div, div.compact div {
+ margin-top: 0.1em;
+ margin-bottom: 0.1em;
+}
+
+div.tableblock > table {
+ border: 3px solid #527bbd;
+}
+thead, p.table.header {
+ font-weight: bold;
+ color: #527bbd;
+}
+tfoot {
+ font-weight: bold;
+}
+td > div.verse {
+ white-space: pre;
+}
+p.table {
+ margin-top: 0;
+}
+/* Because the table frame attribute is overriden by CSS in most browsers. */
+div.tableblock > table[frame="void"] {
+ border-style: none;
+}
+div.tableblock > table[frame="hsides"] {
+ border-left-style: none;
+ border-right-style: none;
+}
+div.tableblock > table[frame="vsides"] {
+ border-top-style: none;
+ border-bottom-style: none;
+}
+
+
+div.hdlist {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+div.hdlist tr {
+ padding-bottom: 15px;
+}
+dt.hdlist1.strong, td.hdlist1.strong {
+ font-weight: bold;
+}
+td.hdlist1 {
+ vertical-align: top;
+ font-style: normal;
+ padding-right: 0.8em;
+ color: navy;
+}
+td.hdlist2 {
+ vertical-align: top;
+}
+div.hdlist.compact tr {
+ margin: 0;
+ padding-bottom: 0;
+}
+
+.comment {
+ background: yellow;
+}
+
+.footnote, .footnoteref {
+ font-size: 0.8em;
+}
+
+span.footnote, span.footnoteref {
+ vertical-align: super;
+}
+
+#footnotes {
+ margin: 20px 0 20px 0;
+ padding: 7px 0 0 0;
+}
+
+#footnotes div.footnote {
+ margin: 0 0 5px 0;
+}
+
+#footnotes hr {
+ border: none;
+ border-top: 1px solid silver;
+ height: 1px;
+ text-align: left;
+ margin-left: 0;
+ width: 20%;
+ min-width: 100px;
+}
+
+div.colist td {
+ padding-right: 0.5em;
+ padding-bottom: 0.3em;
+ vertical-align: top;
+}
+div.colist td img {
+ margin-top: 0.3em;
+}
+
+ at media print {
+ div#footer-badges { display: none; }
+}
+
+div#toc {
+ margin-bottom: 2.5em;
+}
+
+div#toctitle {
+ color: #527bbd;
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 1.0em;
+ margin-bottom: 0.1em;
+}
+
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+div.toclevel2 {
+ margin-left: 2em;
+ font-size: 0.9em;
+}
+div.toclevel3 {
+ margin-left: 4em;
+ font-size: 0.9em;
+}
+div.toclevel4 {
+ margin-left: 6em;
+ font-size: 0.9em;
+}
+
+</style>
+<script type="text/javascript">
+/*<+'])');
+ // Function that scans the DOM tree for header elements (the DOM2
+ // nodeIterator API would be a better technique but not supported by all
+ // browsers).
+ var iterate = function (el) {
+ for (var i = el.firstChild; i != null; i = i.nextSibling) {
+ if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
+ var mo = re.exec(i.tagName);
+ if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
+ result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
+ }
+ iterate(i);
+ }
+ }
+ }
+ iterate(el);
+ return result;
+ }
+
+ var toc = document.getElementById("toc");
+ var entries = tocEntries(document.getElementById("content"), toclevels);
+ for (var i = 0; i < entries.length; ++i) {
+ var entry = entries[i];
+ if (entry.element.id == "")
+ entry.element.id = "_toc_" + i;
+ var a = document.createElement("a");
+ a.href = "#" + entry.element.id;
+ a.appendChild(document.createTextNode(entry.text));
+ var div = document.createElement("div");
+ div.appendChild(a);
+ div.className = "toclevel" + entry.toclevel;
+ toc.appendChild(div);
+ }
+ if (entries.length == 0)
+ toc.parentNode.removeChild(toc);
+},
+
+
+/////////////////////////////////////////////////////////////////////
+// Footnotes generator
+/////////////////////////////////////////////////////////////////////
+
+/* Based on footnote generation code from:
+ * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
+ */
+
+footnotes: function () {
+ var cont = document.getElementById("content");
+ var noteholder = document.getElementById("footnotes");
+ var spans = cont.getElementsByTagName("span");
+ var refs = {};
+ var n = 0;
+ for (i=0; i<spans.length; i++) {
+ if (spans[i].className == "footnote") {
+ n++;
+ // Use [\s\S] in place of . so multi-line matches work.
+ // Because JavaScript has no s (dotall) regex flag.
+ note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
+ noteholder.innerHTML +=
+ "<div class='footnote' id='_footnote_" + n + "'>" +
+ "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
+ n + "</a>. " + note + "</div>";
+ spans[i].innerHTML =
+ "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ var id =spans[i].getAttribute("id");
+ if (id != null) refs["#"+id] = n;
+ }
+ }
+ if (n == 0)
+ noteholder.parentNode.removeChild(noteholder);
+ else {
+ // Process footnoterefs.
+ for (i=0; i<spans.length; i++) {
+ if (spans[i].className == "footnoteref") {
+ var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
+ href = href.match(/#.*/)[0]; // Because IE return full URL.
+ n = refs[href];
+ spans[i].innerHTML =
+ "[<a href='#_footnote_" + n +
+ "' title='View footnote' class='footnote'>" + n + "</a>]";
+ }
+ }
+ }
+}
+
+}
+/*]]>*/
+</script>
+</head>
+<body class="article">
+<div id="header">
+</div>
+<div id="content">
+<div class="sect1">
+<h2 id="_prerequisites">Prerequisites</h2>
+<div class="sectionbody">
+<div class="paragraph"><p>There are several prerequisites for building documentation:</p></div>
+<div class="ulist"><ul>
+<li>
+<p>
+asciidoc and a2x (<a href="http://www.methods.co.nz/asciidoc">http://www.methods.co.nz/asciidoc</a>)
+</p>
+</li>
+<li>
+<p>
+dblatex (<a href="http://dblatex.sourceforge.net">http://dblatex.sourceforge.net</a>)
+</p>
+</li>
+<li>
+<p>
+source-highlight (<a href="http://www.gnu.org/software/src-highlite">http://www.gnu.org/software/src-highlite</a>)
+</p>
+</li>
+</ul></div>
+<div class="paragraph"><p>For CI users, compiled versions of these packages can be found in ~davidk.</p></div>
+<div class="sect2">
+<h3 id="_build_docs_script">Build Docs Script</h3>
+<div class="paragraph"><p>Before committing any changes to documentation, it is a good idea manually
+build the documentation. The script to build the documentation is
+docs/build_docs.sh.</p></div>
+<div class="paragraph"><p>This script will convert the documents into HTML and PDF, and then copy the
+files to a given output directory.</p></div>
+</div>
+</div>
+</div>
+</div>
+<div id="footnotes"><hr /></div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2011-08-31 12:17:55 CDT
+</div>
+</div>
+</body>
+</html>
Added: branches/release-0.93/docs/documentation/documentation.txt
===================================================================
--- branches/release-0.93/docs/documentation/documentation.txt (rev 0)
+++ branches/release-0.93/docs/documentation/documentation.txt 2011-08-31 17:37:41 UTC (rev 5033)
@@ -0,0 +1,11 @@
+Swift Document Generation
+=========================
+
+include::overview[]
+
+include::structure[]
+
+include::building[]
+
+include::automation[]
+
Added: branches/release-0.93/docs/documentation/overview
===================================================================
--- branches/release-0.93/docs/documentation/overview (rev 0)
+++ branches/release-0.93/docs/documentation/overview 2011-08-31 17:37:41 UTC (rev 5033)
@@ -0,0 +1,5 @@
+Overview
+--------
+This guide provides a brief overview of how Swift Document Generation works. It
+should explain the structure of a docs directory, how to manually build documentation,
+and explain how document automation works.
Added: branches/release-0.93/docs/documentation/structure
===================================================================
--- branches/release-0.93/docs/documentation/structure (rev 0)
+++ branches/release-0.93/docs/documentation/structure 2011-08-31 17:37:41 UTC (rev 5033)
@@ -0,0 +1,60 @@
+Structure
+---------
+A specific file and directory structure is required for each document in order to ease the
+process of automation, conversion, and copying.
+
+Directories
+~~~~~~~~~~~
+Each subdirectory within docs/ should correspond to the name of the document.
+This name will also later be used in the URL used to point to the
+document.
+
+.Example Directory Names
+-----
+docs/userguide
+docs/tutorial
+-----
+
+AsciiDoc File
+~~~~~~~~~~~~~
+Every document directory should contain one file with a .txt
+extension. This .txt file is the AsciiDoc document that later gets converted
+to various formats.
+
+.Example AsciiDoc Documents
+-----
+docs/userguide/userguide.txt
+docs/tutorial/tutorial.txt
+-----
+
+Chapters
+~~~~~~~~
+Each document directory should contain individual chapters
+that make up the document. These chapters should not have any
+file extensions.
+
+.Example Chapters
+-----
+docs/userguide/overview
+docs/userguide/language
+docs/userguide/mappers
+docs/userguide/commands
+-----
+
+Including Chapters in a Document
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The .txt file should then include the individual chapters
+with the AsciiDoc include command.
+
+.userguide.txt
+-----
+\include::overview[]
+
+\include::language[]
+
+\include::mappers[]
+
+\include::commands[]
+-----
+
+WARNING: Be sure to include spaces between includes. Putting them together with no spaces can cause formatting/compilation errors.
More information about the Swift-commit
mailing list