| @@ -9,7 +9,8 @@ DocNet uses a json file to determine what to do in what form. The format is stra | |||
| "Source" : "sourcefolder", | |||
| "Destination" : "destinationfolder", | |||
| "IncludeSource": "includefolder", | |||
| "Theme" : "themefolder", | |||
| "Theme" : "themename", | |||
| "ThemeFolder" : "themefolder", | |||
| "SourceFoldersToCopy" : ["folder1", "foldern"], | |||
| "Footer" : "footer text or HTML", | |||
| "StartingPageName" : "Home", | |||
| @@ -49,7 +50,12 @@ Specifies the folder where the output will be written to (.htm files). The outpu | |||
| Specifies the folder where the files specified to be included using [@@include directives](markdownextensions.htm#include-files) are located. If `IncludeSource` isn't specified, the value `Includes` is assumed. | |||
| ### Theme | |||
| Specifies the folder within the `Themes` folder in the folder the `docnet` executable is located which is used as the theme for the pages to generate. `Docnet` expects a file called `PageTemplate.htm` within the specified `Theme` folder, which contains the HTML which is used as the wrapper file for the HTML generated from the markdown. It has to contain a couple of marker, which are described later in this document. If `Theme` isn't specified, `Default` is assumed. | |||
| Specifies the name of the theme to use which is a folder within the `Themes` folder in the folder the `docnet` executable is located which is used as the theme for the pages to generate. `Docnet` expects a file called `PageTemplate.htm` within the specified `Theme` folder, which contains the HTML which is used as the wrapper file for the HTML generated from the markdown. It has to contain a couple of marker, which are described later in this document. If `Theme` isn't specified, `Default` is assumed. | |||
| If `ThemeFolder` is specified, the theme is looked up in that folder. | |||
| ### ThemeFolder | |||
| Optional folder specification of the folder which contains the theme specified in `Theme`. If not specified, the `Themes` folder of the docnet executable is used. | |||
| ### SourceFoldersToCopy | |||
| This is an optional directive with, if specified, one or more folder names relative to `Source`, which contain files to copy to the `Destination` folder. E.g. image files used in the markdown files, located in an `Images` folder can be copied this way to the output folder reliably. All folders specified are copied recursively. | |||
| @@ -42,7 +42,6 @@ | |||
| <li class="tocentry"><a href="search.htm">Search</a> | |||
| </li> | |||
| <li class="tocentry current"><a class="current" href="acknowledgements.htm">Acknowledgements</a> | |||
| </li> | |||
| <li class="tocentry"><a href="license.htm">License</a> | |||
| </li> | |||
| </ul> | |||
| @@ -48,6 +48,8 @@ | |||
| <li class="tocentry"><a href="#theme">Theme</a></li> | |||
| <li class="tocentry"><a href="#themefolder">ThemeFolder</a></li> | |||
| <li class="tocentry"><a href="#sourcefolderstocopy">SourceFoldersToCopy</a></li> | |||
| <li class="tocentry"><a href="#convertlocallinks">ConvertLocalLinks</a></li> | |||
| @@ -121,7 +123,8 @@ | |||
| "Source" : "sourcefolder", | |||
| "Destination" : "destinationfolder", | |||
| "IncludeSource": "includefolder", | |||
| "Theme" : "themefolder", | |||
| "Theme" : "themename", | |||
| "ThemeFolder" : "themefolder", | |||
| "SourceFoldersToCopy" : ["folder1", "foldern"], | |||
| "Footer" : "footer text or HTML", | |||
| "StartingPageName" : "Home", | |||
| @@ -156,7 +159,10 @@ | |||
| <h3 id="includesource">IncludeSource<a class="headerlink" href="#includesource" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3> | |||
| <p>Specifies the folder where the files specified to be included using <a href="markdownextensions.htm#include-files">@@include directives</a> are located. If <code>IncludeSource</code> isn't specified, the value <code>Includes</code> is assumed. </p> | |||
| <h3 id="theme">Theme<a class="headerlink" href="#theme" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3> | |||
| <p>Specifies the folder within the <code>Themes</code> folder in the folder the <code>docnet</code> executable is located which is used as the theme for the pages to generate. <code>Docnet</code> expects a file called <code>PageTemplate.htm</code> within the specified <code>Theme</code> folder, which contains the HTML which is used as the wrapper file for the HTML generated from the markdown. It has to contain a couple of marker, which are described later in this document. If <code>Theme</code> isn't specified, <code>Default</code> is assumed.</p> | |||
| <p>Specifies the name of the theme to use which is a folder within the <code>Themes</code> folder in the folder the <code>docnet</code> executable is located which is used as the theme for the pages to generate. <code>Docnet</code> expects a file called <code>PageTemplate.htm</code> within the specified <code>Theme</code> folder, which contains the HTML which is used as the wrapper file for the HTML generated from the markdown. It has to contain a couple of marker, which are described later in this document. If <code>Theme</code> isn't specified, <code>Default</code> is assumed.</p> | |||
| <p>If <code>ThemeFolder</code> is specified, the theme is looked up in that folder.</p> | |||
| <h3 id="themefolder">ThemeFolder<a class="headerlink" href="#themefolder" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3> | |||
| <p>Optional folder specification of the folder which contains the theme specified in <code>Theme</code>. If not specified, the <code>Themes</code> folder of the docnet executable is used. </p> | |||
| <h3 id="sourcefolderstocopy">SourceFoldersToCopy<a class="headerlink" href="#sourcefolderstocopy" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3> | |||
| <p>This is an optional directive with, if specified, one or more folder names relative to <code>Source</code>, which contain files to copy to the <code>Destination</code> folder. E.g. image files used in the markdown files, located in an <code>Images</code> folder can be copied this way to the output folder reliably. All folders specified are copied recursively.</p> | |||
| <h3 id="convertlocallinks">ConvertLocalLinks<a class="headerlink" href="#convertlocallinks" title="Permalink to this headline"><i class="fa fa-link" aria-hidden="true"></i></a></h3> | |||
| @@ -39,7 +39,6 @@ | |||
| <li class="tocentry"><a href="docnetjson.htm">Site configuration with the docnet.json file</a> | |||
| </li> | |||
| <li class="tocentry current"><a class="current" href="h2leveldiscovery.htm">Automatic H2 level ToC entry discovery</a> | |||
| </li> | |||
| <li class="tocentry"><a href="notfound.htm">Not found (404) page</a> | |||
| </li> | |||
| @@ -44,7 +44,6 @@ | |||
| <li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a> | |||
| </li> | |||
| <li class="tocentry current"><a class="current" href="license.htm">License</a> | |||
| </li> | |||
| </ul> | |||
| <div class="toc-footer"> | |||
| <span class="text-small"> | |||
| @@ -41,7 +41,6 @@ | |||
| <li class="tocentry"><a href="h2leveldiscovery.htm">Automatic H2 level ToC entry discovery</a> | |||
| </li> | |||
| <li class="tocentry current"><a class="current" href="notfound.htm">Not found (404) page</a> | |||
| </li> | |||
| </ul> | |||
| </li> | |||
| @@ -40,7 +40,6 @@ | |||
| <span class="navigationgroup"><i class="fa fa-caret-right"></i> <a href="Authoringcontent.htm">Authoring content</a></span> | |||
| </li> | |||
| <li class="tocentry current"><a class="current" href="search.htm">Search</a> | |||
| </li> | |||
| <li class="tocentry"><a href="acknowledgements.htm">Acknowledgements</a> | |||
| </li> | |||
| <li class="tocentry"><a href="license.htm">License</a> | |||
| @@ -9,7 +9,7 @@ | |||
| { | |||
| "location": "docnetjson.htm", | |||
| "breadcrumbs": "Home / Configuration / Site configuration with the docnet.json file", | |||
| "keywords": "__index _marker_ _Sub 1 1_ 2 3 3rd 4 a A above absolute actual additional alert all All always an and API appear are as assigned assumed Assumes at auto Auto backwards based be becomes Behaves below browsing but by called can case characters clashes clean clicked Combined commas compatibility configuration contain contains Contains content Contents convert converted ConvertLocalLinks copied copy couple create dash Dashes default Default defined described Destination destinationfolder determine Determines directive directives do docnet Docnet DocNet docs document documentation Does doesn dots e E each Each elements empty end ending entry escape etc every example Example except executable exist exists expected expects experience extremely false feature file filename_page1 filename_page2 filename_page3 filename_page4 filenames files first folder folder1 foldern folders following foo footer Footer for form format formatted forward from full Full g generate Generate generated getting given guarantees has have header Header headings home Home how href htm HTML i if If image Images important in include included includefolder Includes IncludeSource inclusion inclusions index info inside into introduction Introduction is isn it It its json later lead level Levels line link links list load loaded local located make markdown markdownextensions marker MaxLevelInToC md more mostly my mydocumentation name Name nameoflevel names navigated navigation never no non Non None not Note of off one only optional or order output own page Page pages Pages PageTemplate parent parse party path paths Paths PathSpecification per placed possibility process put puts recursively reference referene relative Relative RelativeAsFolder reliably remove removing Replaces result resulting results retrieved reusing right root same Search see See sensitive set Sets setting show shown simply site so some Some someintroduction somemarkdownfile source Source sourcefolder SourceFoldersToCopy spaces special specified Specifies specify started starting StartingPageName still straight string strip Strip StripIndexHtm structure sub Sub subfolders suffixed Table target text that the The them theme Theme themefolder Themes there they this This tip title Title titles to To ToC tool tooling topics topictitle touch treated tree true unique unsupported UrlFormatting urls use Use used useful uses using value view want way what when where which wildcard will with within without would wrapper written you", | |||
| "keywords": "__index _marker_ _Sub 1 1_ 2 3 3rd 4 a A above absolute actual additional alert all All always an and API appear are as assigned assumed Assumes at auto Auto backwards based be becomes Behaves below browsing but by called can case characters clashes clean clicked Combined commas compatibility configuration contain contains Contains content Contents convert converted ConvertLocalLinks copied copy couple create dash Dashes default Default defined described Destination destinationfolder determine Determines directive directives do docnet Docnet DocNet docs document documentation Does doesn dots e E each Each elements empty end ending entry escape etc every example Example except executable exist exists expected expects experience extremely false feature file filename_page1 filename_page2 filename_page3 filename_page4 filenames files first folder folder1 foldern folders following foo footer Footer for form format formatted forward from full Full g generate Generate generated getting given guarantees has have header Header headings home Home how href htm HTML i if If image Images important in include included includefolder Includes IncludeSource inclusion inclusions index info inside into introduction Introduction is isn it It its json later lead level Levels line link links list load loaded local located looked make markdown markdownextensions marker MaxLevelInToC md more mostly my mydocumentation name Name nameoflevel names navigated navigation never no non Non None not Note of off one only optional Optional or order output own page Page pages Pages PageTemplate parent parse party path paths Paths PathSpecification per placed possibility process put puts recursively reference referene relative Relative RelativeAsFolder reliably remove removing Replaces result resulting results retrieved reusing right root same Search see See sensitive set Sets setting show shown simply site so some Some someintroduction somemarkdownfile source Source sourcefolder SourceFoldersToCopy spaces special specification specified Specifies specify started starting StartingPageName still straight string strip Strip StripIndexHtm structure sub Sub subfolders suffixed Table target text that the The them theme Theme themefolder ThemeFolder themename Themes there they this This tip title Title titles to To ToC tool tooling topics topictitle touch treated tree true unique unsupported up UrlFormatting urls use Use used useful uses using value view want way what when where which wildcard will with within without would wrapper written you", | |||
| "title": "Site configuration with the docnet.json file" | |||
| }, | |||
| { | |||