From b340971607d3d9f13f147c3c8db545a87b0c6561 Mon Sep 17 00:00:00 2001 From: Frans Bouma Date: Wed, 6 Mar 2019 14:04:08 +0100 Subject: [PATCH] Updated docs with ThemeFolder --- MarkdownSource/docnetjson.md | 10 ++++++++-- acknowledgements.htm | 1 - docnetjson.htm | 10 ++++++++-- h2leveldiscovery.htm | 1 - license.htm | 1 - notfound.htm | 1 - search.htm | 1 - search_index.json | 2 +- 8 files changed, 17 insertions(+), 10 deletions(-) diff --git a/MarkdownSource/docnetjson.md b/MarkdownSource/docnetjson.md index 71803df..7c9230f 100644 --- a/MarkdownSource/docnetjson.md +++ b/MarkdownSource/docnetjson.md @@ -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. diff --git a/acknowledgements.htm b/acknowledgements.htm index 8d9ba9f..262ee1a 100644 --- a/acknowledgements.htm +++ b/acknowledgements.htm @@ -42,7 +42,6 @@
  • Search
  • Acknowledgements -
  • License
    • diff --git a/docnetjson.htm b/docnetjson.htm index 6e86861..7153223 100644 --- a/docnetjson.htm +++ b/docnetjson.htm @@ -48,6 +48,8 @@
  • Theme
    • +
  • ThemeFolder
    • +
  • SourceFoldersToCopy
  • ConvertLocalLinks
    • @@ -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 @@

    IncludeSource

    Specifies the folder where the files specified to be included using @@include directives 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.

    diff --git a/h2leveldiscovery.htm b/h2leveldiscovery.htm index 9bc59f8..087d7ef 100644 --- a/h2leveldiscovery.htm +++ b/h2leveldiscovery.htm @@ -39,7 +39,6 @@
  • Site configuration with the docnet.json file
  • Automatic H2 level ToC entry discovery -
  • Not found (404) page
    • diff --git a/license.htm b/license.htm index 4b8c515..1c5ea1f 100644 --- a/license.htm +++ b/license.htm @@ -44,7 +44,6 @@
  • Acknowledgements
  • License -
    • diff --git a/notfound.htm b/notfound.htm index a71f260..1398b50 100644 --- a/notfound.htm +++ b/notfound.htm @@ -41,7 +41,6 @@
  • Automatic H2 level ToC entry discovery
  • Not found (404) page -
    • diff --git a/search.htm b/search.htm index 5328a77..c6c5f84 100644 --- a/search.htm +++ b/search.htm @@ -40,7 +40,6 @@ Authoring content
  • Search -
  • Acknowledgements
  • License diff --git a/search_index.json b/search_index.json index 94e7aba..326a097 100644 --- a/search_index.json +++ b/search_index.json @@ -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" }, {