From f6cbc71667618f41d5dffbc059d1e6d6bde9788f Mon Sep 17 00:00:00 2001 From: Joan Josep Ordinas Rosa Date: Tue, 11 Apr 2017 17:29:38 +0200 Subject: [PATCH] Changed top level object name --- bin/jqt | 30 +++++++-------------- docs/Makefile | 13 +++++---- docs/blocks/content/markup.html | 2 +- docs/blocks/default.html | 4 +-- docs/blocks/menu-bar/markup.html | 4 +-- docs/blocks/toc/markup.html | 2 +- docs/content/content.md | 10 +++---- docs/content/data.md | 14 +++++----- docs/content/engine.md | 1 - docs/content/{help.markdown => help.text} | 0 docs/content/{jqt.1.markdown => jqt.1.text} | 1 - docs/content/opt/n.txt | 5 ---- docs/data/.gitignore | 0 docs/{content => data}/snippets.yaml | 0 docs/make.d/front-matter.make | 18 ++++++------- docs/make.d/pages.make | 23 +++++++++------- docs/make.d/pathnames.make | 6 ++++- docs/make.d/prelude.make | 5 ++-- docs/make.d/styles.make | 1 - docs/make.d/tools.make | 1 - 20 files changed, 65 insertions(+), 75 deletions(-) rename docs/content/{help.markdown => help.text} (100%) rename docs/content/{jqt.1.markdown => jqt.1.text} (98%) delete mode 100644 docs/content/opt/n.txt delete mode 100644 docs/data/.gitignore rename docs/{content => data}/snippets.yaml (100%) diff --git a/bin/jqt b/bin/jqt index 7f24407..f5fbdd6 100755 --- a/bin/jqt +++ b/bin/jqt @@ -427,23 +427,20 @@ s/tr class="even"/tr/ # Merge document and all data ######################################################################## -declare DOCUMENT_METADATA_NAME='page' # front matter and etc. - declare -A JSON_DATA=() YAML_DATA=() YAML_SNIPPETS=() declare -A JSON_DATA_DOT=() YAML_DATA_DOT=() # Global objects available in jq scripts: -# .page ... -# .page._content -# .page._highlight -# .page._id -# .page._source -# .page._toc +# ._content +# ._highlight +# ._source +# ._toc +# ._front_matter # < stdin > stdout function merge { - local front_matter key id + local front_matter key local -i without_document=0 if [[ $1 == '-w' ]]; then without_document=1 @@ -455,14 +452,9 @@ function merge { if (( without_document )); then echo '{}' # dummy object else - id=${DOCUMENT//\//-} - id=${id#-} - id=${id%.*} - # split . - echo '(. / "") as [$body, $toc, $css] |' - # page - echo "{ $DOCUMENT_METADATA_NAME: ("; yaml2json < $front_matter - echo "+ { _id: \"$id\", _source: \"${DOCUMENT}\", "'_content: $body, _toc: $toc, _highlight: $css })}' + echo '(. / "") as [$body, $toc, $css] | { _front_matter: (' + yaml2json < $front_matter + echo ")} + { _source: \"${DOCUMENT}\", "'_content: $body, _toc: $toc, _highlight: $css }' fi # additional data @@ -609,7 +601,7 @@ declare expand='' declare opt key filename -while getopts :hVD:I:P:L:i:j:45d:weprtn:m:M:T:CHS-: opt; do +while getopts :hVD:I:P:L:i:j:45d:weprt:m:M:T:CHS-: opt; do case $opt in # Generic options h) help @@ -676,8 +668,6 @@ while getopts :hVD:I:P:L:i:j:45d:weprtn:m:M:T:CHS-: opt; do fi fi ;; - n) DOCUMENT_METADATA_NAME=$OPTARG - ;; T) if [[ -z $OPTARG ]]; then snippets=1 elif [[ $OPTARG == '--' ]]; then diff --git a/docs/Makefile b/docs/Makefile index a0d8ef9..a22d8ae 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -189,18 +189,17 @@ ifdef __html__ # Options for `jqt`. JQTFLAGS += \ - -n document \ + -5 \ -I./ \ + -j'$$'pages:$(Metadata)/pages \ -msite:$(Metadata)/config.json \ - -mpages:$(Metadata)/pages.json \ -msections:$(Metadata)/sections.json \ - -5 \ -iblocks/filters \ - -msnippets:$(Metadata)/snippets.json \ --toc-depth=4 \ + -msnippets:$(Metadata)/snippets.json \ # Snippets -$(Metadata)/snippets.json: $(Content)/snippets.yaml \ +$(Metadata)/snippets.json: $(Data)/snippets.yaml \ | $(Metadata) $(info ==> $@) @jqt -T < $< | yaml2json > $@ @@ -230,7 +229,7 @@ GPP_MD := gpp \ ManPage := ../jqt.1.gz # Man page: jqt(1) -$(ManPage): $(Content)/jqt.1.markdown +$(ManPage): $(Content)/jqt.1.text $(info ==> $@) @$(GPP_MD) -I$(Content) < $< \ | pandoc --standalone --from markdown --to man \ @@ -250,7 +249,7 @@ clobber:: # Independent target: helps generating text for `jqt -h` # Needs explicit call: `make /tmp/help` # -/tmp/help: $(Content)/help.markdown +/tmp/help: $(Content)/help.text $(info ==> $@) @jqt -P MarkDown -I$(Content) < $< \ | pandoc --from markdown --to plain - \ diff --git a/docs/blocks/content/markup.html b/docs/blocks/content/markup.html index f1c0dee..07605e4 100644 --- a/docs/blocks/content/markup.html +++ b/docs/blocks/content/markup.html @@ -2,7 +2,7 @@ # Content ######################################################################>&
- {{.document._content}} + {{._content}}
<# vim:ts=2:sw=2:ai:et:fileencoding=utf8:syntax=html diff --git a/docs/blocks/default.html b/docs/blocks/default.html index db2a2e6..2624029 100644 --- a/docs/blocks/default.html +++ b/docs/blocks/default.html @@ -1,7 +1,7 @@ <# Top-level page markup #>& - + <# # Meta elements @@ -19,7 +19,7 @@ - {{.document._highlight}} + {{._highlight}} <# # Document body diff --git a/docs/blocks/menu-bar/markup.html b/docs/blocks/menu-bar/markup.html index d533436..ac768d0 100644 --- a/docs/blocks/menu-bar/markup.html +++ b/docs/blocks/menu-bar/markup.html @@ -2,9 +2,9 @@ # Menu Bar ######################################################################>&
    -{% .site.menu[] %} +{% $pages::pages[0] as $pages | .site.menu[] %}
  1. - {% (. as $id | $M.pages[] | select($id == .id)) as $page %} + {% (. as $id | $pages[] | select($id == .id)) as $page %} {{$page.name}} {% end %}
    2. diff --git a/docs/blocks/toc/markup.html b/docs/blocks/toc/markup.html index ec1e3cf..e14dc6c 100644 --- a/docs/blocks/toc/markup.html +++ b/docs/blocks/toc/markup.html @@ -3,7 +3,7 @@ ######################################################################>& <# vim:ts=2:sw=2:ai:et:fileencoding=utf8:syntax=html diff --git a/docs/content/content.md b/docs/content/content.md index 904938f..69e71e3 100644 --- a/docs/content/content.md +++ b/docs/content/content.md @@ -46,16 +46,16 @@ Document files contain MarkDown text preceded by an optional YAML front matter. ### Front matter <%cite jqt> extracts the YAML front matter, located at the very beginning of the file, -and injects it into the render stage under a global JSON object named `.page`. +and injects it into the render stage under a global JSON object named `._front_matter`. ### Body Pandoc translates the document body to HTML, and <%cite jqt> injects it into the render stage under the global JSON scalar -`.page._content`. If the document contains fenced code blocks specifying the language of -the code block, the related highlight CSS code will be in the scalar `.page._highlight`. Also, the -HTML table of contents is available in the scalar `.page._toc`, and the path to the document -file in the scalar `.page._source`. +`._content`. If the document contains fenced code blocks specifying the language of +the code block, the related highlight CSS code will be in the scalar `._highlight`. Also, the +HTML table of contents is available in the scalar `._toc`, and the path to the document +file in the scalar `._source`. ### MarkDown snippets diff --git a/docs/content/data.md b/docs/content/data.md index bbb2b11..d0bd85a 100644 --- a/docs/content/data.md +++ b/docs/content/data.md @@ -39,7 +39,6 @@ data and influence JSON preprocessing: <%include content/opt/I.txt> <%include content/opt/M.txt> <%include content/opt/m.txt> -<%include content/opt/n.txt> <%include content/opt/T.txt> @@ -54,14 +53,15 @@ Documents front matter metadata and additional input YAML files are converted to JSON and merged to be the `jq` input in the render stage. No preprocessing is applied to YAML data. -The front matter content is available in the global object `.page`. The object -member names prefixed with the underline character (`_`) are reserved, and the following +The front matter content is available in the global object `._front_matter`. +Reserved global names are prefixed with the underline character (`_`), and the following are provided: -* `.page._content`: the rendered input document. -* `.page._highlight`: CSS styles for highlighted code. -* `.page._source`: the input document pathname as provided to `jqt`. -* `.page._toc`: the rendered input document table of contents. +* `._content`: the rendered input document. +* `._front_matter`: the document front-matter. +* `._highlight`: CSS styles for highlighted code. +* `._source`: the input document pathname as provided to `jqt`. +* `._toc`: the rendered input document table of contents. Additional JSON files can be provided and are merged with front matter metadata to be the `jq` input in the render stage. diff --git a/docs/content/engine.md b/docs/content/engine.md index 6a13e2a..8d0e751 100644 --- a/docs/content/engine.md +++ b/docs/content/engine.md @@ -65,7 +65,6 @@ arguments. The usage possibilities are: <%include content/opt/L.txt> <%include content/opt/M.txt> <%include content/opt/m.txt> -<%include content/opt/n.txt> <%include content/opt/P.txt> <%include content/opt/p.txt> <%include content/opt/r.txt> diff --git a/docs/content/help.markdown b/docs/content/help.text similarity index 100% rename from docs/content/help.markdown rename to docs/content/help.text diff --git a/docs/content/jqt.1.markdown b/docs/content/jqt.1.text similarity index 98% rename from docs/content/jqt.1.markdown rename to docs/content/jqt.1.text index 5de51f6..2b6ab22 100644 --- a/docs/content/jqt.1.markdown +++ b/docs/content/jqt.1.text @@ -34,7 +34,6 @@ where HTML is mixed with **jq** snippets to implement the transformation logic. <%include content/opt/L.txt> <%include content/opt/M.txt> <%include content/opt/m.txt> -<%include content/opt/n.txt> <%include content/opt/P.txt> <%include content/opt/p.txt> <%include content/opt/r.txt> diff --git a/docs/content/opt/n.txt b/docs/content/opt/n.txt deleted file mode 100644 index 5d4a153..0000000 --- a/docs/content/opt/n.txt +++ /dev/null @@ -1,5 +0,0 @@ --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/data/.gitignore b/docs/data/.gitignore deleted file mode 100644 index e69de29..0000000 diff --git a/docs/content/snippets.yaml b/docs/data/snippets.yaml similarity index 100% rename from docs/content/snippets.yaml rename to docs/data/snippets.yaml diff --git a/docs/make.d/front-matter.make b/docs/make.d/front-matter.make index 7d14761..cbcd6e5 100644 --- a/docs/make.d/front-matter.make +++ b/docs/make.d/front-matter.make @@ -50,12 +50,12 @@ endef # Add members to user defined front-matter at `.`. # # Defined by jqt: -# .page._id -# .page._content -# .page._highlight -# .page._toc -# .page._source == $1 -# Defined here: +# ._content +# ._highlight +# ._toc +# ._source +# ._front_matter +# Defined here (front-matter plus...): # .page.base # .page.filename # .page.id @@ -119,15 +119,15 @@ endef define f_NODE_JSON.jq = { \ base: "$(call f_page_base,$1)", \ + date: (now | todateiso8601), \ filename: "$(call f_page_name,$1)", \ id: "$(call f_node_id,$1)", \ isnode: true, \ ispage: false, \ path: "$(call f_page_path,$1)", \ section: "$(call f_page_section,$1)", \ - url: "$(call f_page_url,$1)", \ - date: (now | todateiso8601), \ - title: "$(call f_page_name,$1)" \ + title: "$(call f_page_name,$1)", \ + url: "$(call f_page_url,$1)" \ } as $$node | \ reduce .defaults[] as $$d \ ({}; if "$(call f_node_id,$1)" | test("^" + $$d.idprefix) \ diff --git a/docs/make.d/pages.make b/docs/make.d/pages.make index e6dbf8d..7b8de20 100644 --- a/docs/make.d/pages.make +++ b/docs/make.d/pages.make @@ -1,7 +1,6 @@ ######################################################################## # pages.make # -# Define rules for HTML pages and nodes. # Define standard rules and rules for HTML pages and nodes. # # Imported variables: @@ -16,14 +15,14 @@ # build # clean # clobber -# xbuild -# xxbuild +# touch +# fresh ######################################################################## # Standard targets ######################################################################## -.PHONY: clean clobber build xbuild xxbuild +.PHONY: clean clobber build touch fresh # Copy Assets all:: | $(Destination) @@ -51,14 +50,18 @@ define p_test_and_touch.sh fi endef -xbuild: +touch: @$(p_test_and_touch.sh) @$(MAKE) -s all # Clobber and build again -xxbuild: clobber +fresh: clobber @$(MAKE) -s all +init: + @rm -rf $(Metadata) + @$(MAKE) -s $(Metadata)/html.make + ######################################################################## # Create makefile containing rules for all HTML files ######################################################################## @@ -79,14 +82,16 @@ define p_recipe := "\t$$(info ==> $$@)\n\t@$$(JQT) -mpage:$(Metadata)/pages/"+.id+".json -d $$< $(Layouts)/"+.layout+".html | $$(p_DETAILS) > $$@" endef +define p_layouts := +$(Layouts)/default.html $(Layouts)/"+.layout+".html | $$$$(dir $$$$@)" +endef + # . is $(Metadata)/pages.json define p_PAGES_D_MAKE.jq := "__html__ := 1", \ (.[] | ( \ "$(Destination)/"+.url+": "+(.use|join(" ")), \ - "$(Destination)/"+.url+": $(Layouts)/default.html", \ - "$(Destination)/"+.url+": $(Layouts)/"+.layout+".html", \ - "$(Destination)/"+.url+": | $$$$(dir $$$$@)", \ + "$(Destination)/"+.url+": $(p_layouts), \ "$(Destination)/"+.url+": "+.source+"\n"+$(p_recipe) \ )), "# vim:syntax=make" endef diff --git a/docs/make.d/pathnames.make b/docs/make.d/pathnames.make index 06d3ed1..a3e8080 100644 --- a/docs/make.d/pathnames.make +++ b/docs/make.d/pathnames.make @@ -27,7 +27,9 @@ ######################################################################## # Markdown documents found in the filesystem (only `.md` extensions). -i_documents := $(sort $(shell find $(Content) -type f -a -name '*.md')) +#i_suffixes := -name '*.md' -o -name '*.mkd' -o -name '*.markdown' +i_suffixes := -name '*.md' +i_documents := $(sort $(shell find $(Content) -type f -a $(i_suffixes))) # Unique paths to documents directories. i_paths := $(sort $(dir $(i_documents))) @@ -112,6 +114,8 @@ all:: $(Pages) @echo 'Destination: $(Destination)' @echo @echo 'i_documents: $(i_documents)' + @echo 'i_doc_mkd: $(i_doc_mkd)' + @echo 'i_doc_markdown: $(i_doc_markdown)' @echo 'i_paths: $(i_paths)' @echo @echo 'i_paths_destination: $(i_paths_destination)' diff --git a/docs/make.d/prelude.make b/docs/make.d/prelude.make index 6d0a6e0..d81f70d 100644 --- a/docs/make.d/prelude.make +++ b/docs/make.d/prelude.make @@ -1,7 +1,8 @@ ######################################################################## +# prelude.make +# # The project prelude: common module available in all makefile modules -######################################################################## - +# # Exported macros: # comma # empty diff --git a/docs/make.d/styles.make b/docs/make.d/styles.make index be6649a..4f30d70 100644 --- a/docs/make.d/styles.make +++ b/docs/make.d/styles.make @@ -1,6 +1,5 @@ ######################################################################## # styles.make -######################################################################## # # Generate main CSS stylesheet. # diff --git a/docs/make.d/tools.make b/docs/make.d/tools.make index 7d0b7c9..4a67bc5 100644 --- a/docs/make.d/tools.make +++ b/docs/make.d/tools.make @@ -1,6 +1,5 @@ ######################################################################## # tools.make -######################################################################## # # Tools independent of any target. #