From aa883569ad5163e12047989040165c79fbfd9c6e Mon Sep 17 00:00:00 2001 From: Joan Josep Ordinas Rosa Date: Sat, 1 Apr 2017 10:35:08 +0200 Subject: [PATCH] Restructuring docs --- docs/Makefile | 4 ++-- docs/{content/README.txt => README.md} | 8 +++++--- docs/{ => blocks}/filters.jq | 0 docs/content/opt/4.txt | 1 - docs/content/opt/C.txt | 1 - docs/content/opt/D.txt | 1 - docs/content/opt/H.txt | 1 - docs/content/opt/I.txt | 1 - docs/content/opt/L.txt | 1 - docs/content/opt/M.txt | 1 - docs/content/opt/P.txt | 1 - docs/content/opt/S.txt | 1 - docs/content/opt/T.txt | 1 - docs/content/opt/V.txt | 1 - docs/content/opt/d.txt | 1 - docs/content/opt/e.txt | 1 - docs/content/opt/h.txt | 1 - docs/content/opt/i.txt | 1 - docs/content/opt/j.txt | 1 - docs/content/opt/m.txt | 1 - docs/content/opt/n.txt | 1 - docs/content/opt/p.txt | 1 - docs/content/opt/r.txt | 1 - docs/content/opt/t.txt | 1 - 24 files changed, 7 insertions(+), 26 deletions(-) rename docs/{content/README.txt => README.md} (70%) rename docs/{ => blocks}/filters.jq (100%) diff --git a/docs/Makefile b/docs/Makefile index 14c2665..fcdb04c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -67,7 +67,7 @@ Common := \ $(Blocks)/*/markup.html \ $(Layouts)/default.html \ $(Content)/LINKS.txt \ - filters.jq \ + blocks/filters.jq \ content/markup.m \ # Files to "build" @@ -89,7 +89,7 @@ JQT = jqt $(JQTFLAGS) JQTFLAGS := \ -5 \ -I./ \ - -ifilters \ + -iblocks/filters \ -msite:$(Meta)/config.json \ -msnippets:$(Meta)/snippets.json \ --toc-depth=4 \ diff --git a/docs/content/README.txt b/docs/README.md similarity index 70% rename from docs/content/README.txt rename to docs/README.md index 8771e5d..d7d910e 100644 --- a/docs/content/README.txt +++ b/docs/README.md @@ -1,5 +1,7 @@ -File extension conventions -========================== +## Extension conventions for content files + +The files in the `content` directory must follow some conventions in the file +extensions: * Web site pages - content.md @@ -12,7 +14,7 @@ File extension conventions - EXAMPLE.txt - FLOW.txt - LINKS.txt - - opt/*.txt + - opt/\*.txt * MarkDown snippets - snippets.yaml diff --git a/docs/filters.jq b/docs/blocks/filters.jq similarity index 100% rename from docs/filters.jq rename to docs/blocks/filters.jq diff --git a/docs/content/opt/4.txt b/docs/content/opt/4.txt index a122361..bd4b463 100644 --- a/docs/content/opt/4.txt +++ b/docs/content/opt/4.txt @@ -1,6 +1,5 @@ -4, -5 : Sets the output HTML version (HTML4 / HTML5). - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/C.txt b/docs/content/opt/C.txt index 5f9dc98..92d922f 100644 --- a/docs/content/opt/C.txt +++ b/docs/content/opt/C.txt @@ -1,6 +1,5 @@ -C : Stops processing before the render stage and outputs the full JSON data model. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/D.txt b/docs/content/opt/D.txt index 7705b36..2728d1b 100644 --- a/docs/content/opt/D.txt +++ b/docs/content/opt/D.txt @@ -1,6 +1,5 @@ -D NAME=VAL : Defines the user macro *NAME* as equal to *VAL*. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/H.txt b/docs/content/opt/H.txt index f5befad..c5d8cac 100644 --- a/docs/content/opt/H.txt +++ b/docs/content/opt/H.txt @@ -1,6 +1,5 @@ -H : Stops MarkDown processing after generating HTML (outputs several HTML fragments). - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/I.txt b/docs/content/opt/I.txt index 53af4c0..8d404b0 100644 --- a/docs/content/opt/I.txt +++ b/docs/content/opt/I.txt @@ -1,7 +1,6 @@ -I DIRECTORY : Appends *DIRECTORY* to the end of the preprocessor list of directories to be searched for include files. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/L.txt b/docs/content/opt/L.txt index 4a99fb6..24b1789 100644 --- a/docs/content/opt/L.txt +++ b/docs/content/opt/L.txt @@ -1,7 +1,6 @@ -L DIRECTORY : Appends *DIRECTORY* to the end of the jq list of directories to be searched for included and imported modules. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/M.txt b/docs/content/opt/M.txt index e4f46c2..ff9a215 100644 --- a/docs/content/opt/M.txt +++ b/docs/content/opt/M.txt @@ -1,7 +1,6 @@ -M NAME:FILE : Adds a *FILE* in YAML or JSON format to the input data at the top level (*NAME* is ignored but must be present and unique). - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/P.txt b/docs/content/opt/P.txt index 6d35429..e7fce38 100644 --- a/docs/content/opt/P.txt +++ b/docs/content/opt/P.txt @@ -1,7 +1,6 @@ -P LANGUAGE : Expands input file with the macro-processor (*LANGUAGE* can be `jqt`, `md`, `json`, `css` or `css-min`). - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/S.txt b/docs/content/opt/S.txt index 7fb5a24..8ca1b20 100644 --- a/docs/content/opt/S.txt +++ b/docs/content/opt/S.txt @@ -1,6 +1,5 @@ -S : Stops template processing before the render stage (outputs the jq script). - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/T.txt b/docs/content/opt/T.txt index fe1421a..5756c40 100644 --- a/docs/content/opt/T.txt +++ b/docs/content/opt/T.txt @@ -2,7 +2,6 @@ : Transforms front matter YAML top level MarkDown scalar values to HTML. If *NAME:FILE* is provided add the transformed data to the input data as a value of object *NAME*. Otherwise, outputs a new YAML document. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/V.txt b/docs/content/opt/V.txt index 15371ea..e434aba 100644 --- a/docs/content/opt/V.txt +++ b/docs/content/opt/V.txt @@ -1,6 +1,5 @@ -V, --version : Displays version information. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/d.txt b/docs/content/opt/d.txt index 40e5c4f..1b9c887 100644 --- a/docs/content/opt/d.txt +++ b/docs/content/opt/d.txt @@ -1,6 +1,5 @@ -d FILE : Reads the content document from *FILE*. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/e.txt b/docs/content/opt/e.txt index 7a3c4a4..f7bb9b3 100644 --- a/docs/content/opt/e.txt +++ b/docs/content/opt/e.txt @@ -1,6 +1,5 @@ -e : Extracts and outputs the MarkDown document YAML front matter. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/h.txt b/docs/content/opt/h.txt index 7c0c9d8..20ba9b6 100644 --- a/docs/content/opt/h.txt +++ b/docs/content/opt/h.txt @@ -1,6 +1,5 @@ -h, --help : Displays this message. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/i.txt b/docs/content/opt/i.txt index a314099..147ba53 100644 --- a/docs/content/opt/i.txt +++ b/docs/content/opt/i.txt @@ -1,6 +1,5 @@ -i MODULE : Includes the jq *MODULE* in the render stage. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/j.txt b/docs/content/opt/j.txt index f8a7ff2..8b8b139 100644 --- a/docs/content/opt/j.txt +++ b/docs/content/opt/j.txt @@ -1,6 +1,5 @@ -j MODULE:NAME : Imports the jq *MODULE* in the render stage. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/m.txt b/docs/content/opt/m.txt index 4b76a50..84c8d43 100644 --- a/docs/content/opt/m.txt +++ b/docs/content/opt/m.txt @@ -1,6 +1,5 @@ -m NAME:FILE : Adds a *FILE* in YAML or JSON format to the input data as the value of object *NAME*. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/n.txt b/docs/content/opt/n.txt index 0c792e4..5d4a153 100644 --- a/docs/content/opt/n.txt +++ b/docs/content/opt/n.txt @@ -1,6 +1,5 @@ -n NAME : Defines the name for YAML document metadata in _jq_ scripts (defaults to `page`). - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/p.txt b/docs/content/opt/p.txt index c677dbf..76de331 100644 --- a/docs/content/opt/p.txt +++ b/docs/content/opt/p.txt @@ -1,6 +1,5 @@ -p : Prints list of Pandoc accepted options. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/r.txt b/docs/content/opt/r.txt index 40f01d6..989ac14 100644 --- a/docs/content/opt/r.txt +++ b/docs/content/opt/r.txt @@ -1,6 +1,5 @@ -r : Removes the MarkDown document YAML front matter and outputs the document body. - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #> diff --git a/docs/content/opt/t.txt b/docs/content/opt/t.txt index 59812c4..82a4cfd 100644 --- a/docs/content/opt/t.txt +++ b/docs/content/opt/t.txt @@ -1,6 +1,5 @@ -t : Tests presence of front matter in MarkDown (indicated in the output status). - <# vim:ts=4:sw=4:ai:et:fileencoding=utf8:syntax=markdown #>