docgen-tool 2.1.3 → 3.0.1

package/source/user-guide/advanced-content.txt

@@ -1,171 +0,0 @@
-<style>
-.container {
-  box-sizing: border-box;
-  float:left;
-  width: 480px;
-}
-.codeContainer {
-  margin: 0 20px 0 0;
-}
-.codeContainer pre {
-  margin: 0;
-}
-.codeContainer code {
-}
-.codeContainer p {
-  margin: 0;
-  padding: 0;
-}
-.exampleContainer {
-  margin: 0;
-  border: 1px solid #666;
-  border-radius: 6px;
-  padding: 0 18px 0 18px;
-}
-.exampleContainer img {
-  margin-top: 5px;
-}
-#content table {
-  width: 400px!important;
-}
-.hljs-change {
-  background-color: initial!important;
-}
-</style>
-
-Advanced styles
----------------
-
-DocGen is built on the [Webknife CSS framework](http://mtmacdonald.github.io/webknife). Any of the HTML elements and 
-styles from Webknife can be used in a DocGen source file. For details, see 
-the [Webknife reference guide](http://mtmacdonald.github.io/webknife/docs/reference.html).
-
-Basic tables
-------------
-
-Basic tables can be inserted with the Github-flavoured Markdown
-[table extension](https://help.github.com/articles/github-flavored-markdown/#tables).
-
-<div class="container codeContainer">
-<pre><code>| Heading    | Heading    | Heading |
-|:-----------:----------:|--------:|
-| Something  | Something  | ?       |
-| Another    | Another    | ?       |
-| One more   | One more   | ?       |</code></pre>
-</div>
-<div class="container exampleContainer">
-<table class="w-table w-fixed w-stripe">
-<thead>
-<tr>
-<th style="text-align:left">Heading</th>
-<th style="text-align:center">Heading</th>
-<th style="text-align:right">Heading</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td style="text-align:left">Something</td>
-<td style="text-align:center">Something</td>
-<td style="text-align:right">?</td>
-</tr>
-<tr>
-<td style="text-align:left">Another</td>
-<td style="text-align:center">Another</td>
-<td style="text-align:right">?</td>
-</tr>
-<tr>
-<td style="text-align:left">One more</td>
-<td style="text-align:center">One more</td>
-<td style="text-align:right">?</td>
-</tr>
-</tbody>
-</table>
-</div><br class="w-clear"/>
-
-HTML tables
------------
-
-Regular HTML can also be used for tables, allowing full custom styling (including table and column widths).
-
-<div class="container codeContainer">
-<pre><code>&lt;table style=&quot;width:100%;&quot;&gt;
- &lt;tr&gt;
-  &lt;th&gt;Heading&lt;/th&gt;
-  &lt;th&gt;Heading&lt;/th&gt;
-  &lt;th&gt;Heading&lt;/th&gt;
- &lt;/tr&gt;
- &lt;tr&gt;
-  &lt;td class=&quot;bold&quot;&gt;Example&lt;/td&gt;
-  &lt;td&gt;Example&lt;/td&gt;
-  &lt;td&gt;Example&lt;/td&gt;
- &lt;/tr&gt;
- &lt;tr&gt;
-  &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
-  &lt;td class=&quot;w-success-text&quot;&gt;Example&lt;/td&gt;
-  &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;checkmark&quot;&gt;&lt;/span&gt;&lt;/td&gt;
- &lt;/tr&gt;
- &lt;tr&gt;
-  &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
-  &lt;td class=&quot;w-error-text&quot;&gt;Example&lt;/td&gt;
-  &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;close&quot;&gt;&lt;/td&gt;
- &lt;/tr&gt;
-&lt;/table&gt;</code></pre>
-</div>
-<div class="container exampleContainer">
-<table style="width:100%;">
- <tr>
-  <th>Heading</th>
-  <th>Heading</th>
-  <th>Heading</th>
- </tr>
- <tr>
-  <td class="bold">Example</td>
-  <td>Example</td>
-  <td>Example</td>
- </tr>
- <tr>
-  <td><strong>Example</strong></td>
-  <td class="w-success-text">Example</td>
-  <td><span class="w-icon" data-name="checkmark"></span></td>
- </tr>
- <tr>
-  <td><strong>Example</strong></td>
-  <td class="w-error-text">Example</td>
-  <td><span class="w-icon" data-name="close"></td>
- </tr>
-</table>
-</div><br class="w-clear"/>
-
-Creating internal links to page sections
-----------------------------------------
-
-To create links to other sections within one content page, put hyphens between the words in the heading and prepend with #:
-
-	[link to heading](#this-is-a-heading)
-
-	... other page content here ...
-	
-	This is a heading
-	-----------------
-
-Creating internal links to other pages
---------------------------------------
-
-To create links to *other* content pages provide the relative url to the page:
-
-	[link to heading](example-page.html)
-
-Control of page breaks in the PDF
----------------------------------
-
-DocGen does not provide precision control over PDF layout. However, some steps can be taken in case of page break 
-issues (the most common problem).
-
-To *force* a page break, insert the following before an element that should appear on a new page:
-
-	<p class="dg-forceBreak"></p>
-
-DocGen automatically tries to eliminate page breaks *inside* code blocks, block quotes, and table rows. 
-To apply the same technique to other elements, revert to HTML and apply the **dg-avoidBreak** class. For example:
-
-	<p class="dg-avoidBreak">A long paragraph</p>

package/source/user-guide/commonmark.txt

@@ -1,156 +0,0 @@
-This section shows examples of how to write content with CommonMark. See the [CommonMark Spec](http://spec.commonmark.org)
-for more detailed information.
-
-<style>
-.reference pre, .reference table, .reference blockquote {
-  margin: 0;
-}
-.reference .codeCell pre {
-  border: none;
-  border-radius: 0;
-}
-.reference .codeCell {
-  padding: 0;
-}
-</style>
-
-<div>
-
-<table class="reference" style="width: 100%">
-
-<tr><th>Element</th><th>What you type</th><th>What it looks like in DocGen</th></tr>
-
-<tr>
- <td class="r1">Page Heading</td>
- <td class="codeCell"><pre><code>  
-  Page Heading
-  ============
- </code></pre></td>
- <td>
-  <p class="dg-fakeHeading" style="font-size: 20px; padding-bottom: 6px;">Page Heading</p>
-</td>
-</tr>
-
-<tr>
- <td class="r1">Section Heading</td>
- <td class="codeCell"><pre><code> 
-  Section Heading
-  ---------------
- </code></pre></td>
- <td>
-  <p class="dg-fakeHeading" style="font-size: 18px; padding-bottom: 4px;">Section Heading</p>
- </td>
-</tr>
-
-<tr>
- <td class="r1">Minor Heading</td>
- <td class="codeCell"><pre><code> 
-  ### Minor Heading
- </code></pre></td>
- <td>
-  <p class="dg-fakeHeading" style="font-size: 16px; padding-bottom: 4px;">Minor Heading</p>
- </td>
-</tr>
-
-<tr>
- <td class="r1">Fake Heading<br />(not in PDF contents list)</td>
- <td class="codeCell"><pre><code> 
-  &lt;p class="dg-fakeHeading">Fake&lt;/p>
- </code></pre></td>
- <td>
-  <p class="dg-fakeHeading">Fake</p>
- </td>
-</tr>
-
-<tr>
- <td class="r1">Emphasis (italic)</td>
- <td class="codeCell"><pre><code> 
-  This text has *emphasis*
- </code></pre></td>
- <td>This text has <em>emphasis</em></td>
-</tr>
-
-<tr>
- <td class="r1">Strong (bold)</td>
- <td class="codeCell"><pre><code> 
-  This text is **bold**
- </code></pre></td>
- <td>This text is <strong>bold</strong></td>
-</tr>
-
-<tr>
- <td class="r1">Block quotes</td>
-<td class="codeCell"><pre><code>   
-  > This is a block quote.
- </code></pre></td>
- <td><blockquote>This is a block quote</blockquote></td>
-</tr>
-
-<tr>
- <td class="r1">Code block<br/> (indent with tab)</td>
- <td class="codeCell"><pre><code> 
- &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;int some_code=0
- </code></td>
- <td><pre><code>int some_code=0;</code></pre></td>
-</tr>
-
-<tr>
- <td class="r1">Unordered List</td>
- <td class="codeCell"><pre><code> 
-  * unordered list
-  * (items)
- </code></pre></td>
- <td><ul><li>unordered list</li><li>(items)</li></ul></td>
-</tr>
-
-<tr>
- <td class="r1">Ordered List</td>
- <td class="codeCell"><pre><code> 
-  1. ordered list
-  2. (items)
- </code></pre></td>
- <td><ol><li>ordered list</li><li>(items)</li></ol></td>
-</tr>
-
-<tr>
- <td class="r1">External Links</td>
- <td class="codeCell"><pre><code> 
-  [link](http://www.google.com)
- </code></pre></td>
- <td><a href="http://www.google.com">link</a></td>
-</tr>
-
-<tr>
- <td class="r1">Links to a local file</td>
- <td class="codeCell"><pre><code> 
-  [attachment](user_guide.pdf)
- </code></pre></td>
- <td><a href="user_guide.pdf">attachment</a></td>
-</tr>
-
-<tr>
- <td class="r1">Diagrams<br/> (embedding images)</td>
- <td class="codeCell"><pre><code> 
-  ![](files/images/logo.png)
- </code></pre></td>
- <td><img src="files/images/logo.png"></td>
-</tr>
-
-<tr>
- <td class="r1">Simple table</td>
- <td class="codeCell"><pre><code>  
-  | Cell 1 | Cell 2 | Cell 3 |
-  | Cell 4 | Cell 5 | Cell 6 |
- </code></pre></td>
- <td>
- 
-  <table style="width:300px;">
-   <tr><td>Cell 1</td><td>Cell 2</td><td>Cell 3</td></tr>
-   <tr><td>Cell 4</td><td>Cell 5</td><td>Cell 6</td></tr>
-  </table>
-  
- </td>
-</tr>
-
-</table>
-</div>

package/source/user-guide/contents.json

@@ -1,57 +0,0 @@
-[
-	{
-		"heading" : "Quick Start",
-		"column" : 1,
-		"pages" : [
-			{
-				"title": "Overview",
-				"source": "index.txt",
-				"html": true
-			},
-			{
-				"title": "Installation",
-				"source": "installation.txt"
-			},
-			{
-				"title": "Upgrading",
-				"source": "upgrading.txt"
-			}
-		]
-	},
-	{
-		"heading" : "User Guide",
-		"column" : 2,
-		"pages" : [
-			{
-				"title": "Running DocGen",
-				"source": "running.txt"
-			},
-			{
-				"title": "Writing content",
-				"source": "writing-content.txt"
-			},
-			{
-				"title": "CommonMark reference",
-				"source": "commonmark.txt"
-			},
-			{
-				"title": "Advanced content",
-				"source": "advanced-content.txt"
-			}
-		]
-	},
-	{
-		"heading" : "Help",
-		"column" : 3,
-		"pages" : [
-			{
-				"title": "Troubleshooting",
-				"source": "troubleshooting.txt"
-			},
-			{
-				"title": "Using with version control",
-				"source": "version-control.txt"
-			}
-		]
-	}
-]