From 13de5f4cbbea7981d574cfaf727dd0a076329ad7 Mon Sep 17 00:00:00 2001 From: Dan Allen <dan.j.allen@gmail.com> Date: Fri, 4 Dec 2020 17:04:19 -0700 Subject: [PATCH] resolves #17 fix nav grouping (PR #18) * rename first nav to nav-top.adoc * create separate nav files for document and element attributes * create separate nav file for breaks * use same structure for all nav files * put each top level item in its own list --- antora.yml | 6 ++- modules/ROOT/{nav.adoc => nav-top.adoc} | 0 .../{nav.adoc => nav-document.adoc} | 5 -- modules/attributes/nav-element.adoc | 5 ++ modules/blocks/nav-breaks.adoc | 1 + modules/blocks/nav-paragraph.adoc | 1 - modules/blocks/nav-styles.adoc | 9 ++++ modules/directives/nav.adoc | 2 + modules/document/nav.adoc | 2 + modules/lists/nav.adoc | 2 + modules/macros/nav.adoc | 16 +++++-- modules/sections/nav.adoc | 46 +++++++++---------- modules/verbatim/nav.adoc | 16 +++---- 13 files changed, 68 insertions(+), 43 deletions(-) rename modules/ROOT/{nav.adoc => nav-top.adoc} (100%) rename modules/attributes/{nav.adoc => nav-document.adoc} (76%) create mode 100644 modules/attributes/nav-element.adoc create mode 100644 modules/blocks/nav-breaks.adoc diff --git a/antora.yml b/antora.yml index 915d9e2..c78a858 100644 --- a/antora.yml +++ b/antora.yml @@ -8,12 +8,14 @@ asciidoc: listing-caption: Example@ release-version: '2.0.12' nav: -- modules/ROOT/nav.adoc +- modules/ROOT/nav-top.adoc - modules/blocks/nav-basics.adoc -- modules/attributes/nav.adoc +- modules/attributes/nav-document.adoc +- modules/attributes/nav-element.adoc - modules/document/nav.adoc - modules/sections/nav.adoc - modules/blocks/nav-paragraph.adoc +- modules/blocks/nav-breaks.adoc - modules/text/nav.adoc - modules/lists/nav.adoc - modules/macros/nav.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav-top.adoc similarity index 100% rename from modules/ROOT/nav.adoc rename to modules/ROOT/nav-top.adoc diff --git a/modules/attributes/nav.adoc b/modules/attributes/nav-document.adoc similarity index 76% rename from modules/attributes/nav.adoc rename to modules/attributes/nav-document.adoc index 5a87892..19c2fce 100644 --- a/modules/attributes/nav.adoc +++ b/modules/attributes/nav-document.adoc @@ -11,8 +11,3 @@ ** xref:reference-attributes.adoc[] *** xref:unresolved-references.adoc[] ** xref:assignment-precedence.adoc[] -* xref:element-attributes.adoc[] -** xref:positional-and-named-attributes.adoc[] -** xref:ids.adoc[] -** xref:options.adoc[] -** xref:roles.adoc[] diff --git a/modules/attributes/nav-element.adoc b/modules/attributes/nav-element.adoc new file mode 100644 index 0000000..7a85c1f --- /dev/null +++ b/modules/attributes/nav-element.adoc @@ -0,0 +1,5 @@ +* xref:element-attributes.adoc[] +** xref:positional-and-named-attributes.adoc[] +** xref:ids.adoc[] +** xref:options.adoc[] +** xref:roles.adoc[] diff --git a/modules/blocks/nav-breaks.adoc b/modules/blocks/nav-breaks.adoc new file mode 100644 index 0000000..0b76f6f --- /dev/null +++ b/modules/blocks/nav-breaks.adoc @@ -0,0 +1 @@ +* xref:breaks.adoc[] diff --git a/modules/blocks/nav-paragraph.adoc b/modules/blocks/nav-paragraph.adoc index 515b276..63a0906 100644 --- a/modules/blocks/nav-paragraph.adoc +++ b/modules/blocks/nav-paragraph.adoc @@ -2,4 +2,3 @@ ** xref:hard-line-breaks.adoc[] ** xref:preamble-and-lead.adoc[] ** xref:paragraph-alignment.adoc[] -* xref:breaks.adoc[] diff --git a/modules/blocks/nav-styles.adoc b/modules/blocks/nav-styles.adoc index 172ca89..eac15e5 100644 --- a/modules/blocks/nav-styles.adoc +++ b/modules/blocks/nav-styles.adoc @@ -1,5 +1,14 @@ +[] * xref:admonitions.adoc[] + +[] * xref:sidebars.adoc[] + +[] * xref:example-blocks.adoc[] + +[] * xref:blockquotes.adoc[] + +[] * xref:verses.adoc[] diff --git a/modules/directives/nav.adoc b/modules/directives/nav.adoc index 367f35e..0f4bcbb 100644 --- a/modules/directives/nav.adoc +++ b/modules/directives/nav.adoc @@ -6,6 +6,8 @@ ** xref:include-tagged-regions.adoc[] ** xref:include-lines.adoc[] ** xref:include-uri.adoc[] + +[] * xref:conditionals.adoc[] ** xref:ifdef-ifndef.adoc[] ** xref:ifeval.adoc[] diff --git a/modules/document/nav.adoc b/modules/document/nav.adoc index d72600f..c3bcba1 100644 --- a/modules/document/nav.adoc +++ b/modules/document/nav.adoc @@ -14,4 +14,6 @@ *** xref:reference-revision-attributes.adoc[] ** xref:metadata.adoc[] ** xref:header-ref.adoc[] + +[] * xref:doctypes.adoc[] diff --git a/modules/lists/nav.adoc b/modules/lists/nav.adoc index da9cede..645e71f 100644 --- a/modules/lists/nav.adoc +++ b/modules/lists/nav.adoc @@ -3,5 +3,7 @@ ** xref:ordered.adoc[] ** xref:checklist.adoc[] ** xref:continuation.adoc[] + +[] * xref:description.adoc[] ** xref:qanda.adoc[] diff --git a/modules/macros/nav.adoc b/modules/macros/nav.adoc index 5278123..a5f315f 100644 --- a/modules/macros/nav.adoc +++ b/modules/macros/nav.adoc @@ -6,11 +6,17 @@ ** xref:link-macro-attribute-parsing.adoc[] ** xref:complex-urls.adoc[] ** xref:link-macro-ref.adoc[] + +[] * xref:xref.adoc[] ** xref:inter-document-xref.adoc[] ** xref:xref-text-and-style.adoc[] ** xref:xref-validate.adoc[] + +[] * xref:footnote.adoc[] + +[] * xref:images.adoc[] ** xref:images-directory.adoc[] ** xref:image-url.adoc[] @@ -18,10 +24,12 @@ ** xref:image-size.adoc[] ** xref:image-svg.adoc[] ** xref:image-ref.adoc[] + +[] * xref:audio-and-video.adoc[] -* xref:icons.adoc[] -** xref:icons-image.adoc[] -** xref:icons-font.adoc[] -** xref:icon-macro.adoc[] + +[] * xref:keyboard-macro.adoc[] + +[] * xref:ui-macros.adoc[] diff --git a/modules/sections/nav.adoc b/modules/sections/nav.adoc index 408a82c..fb00d72 100644 --- a/modules/sections/nav.adoc +++ b/modules/sections/nav.adoc @@ -1,26 +1,26 @@ -.Sections -* xref:titles-and-levels.adoc[] -** xref:title-links.adoc[] -** xref:discrete-titles.adoc[] -* xref:ids.adoc[] -** xref:id-prefix-and-separator.adoc[] -* xref:custom-ids.adoc[] -* xref:numbers.adoc[] -* xref:styles.adoc[] -** xref:special-section-titles.adoc[] -** xref:special-section-numbers.adoc[] +* Sections +** xref:titles-and-levels.adoc[] +*** xref:title-links.adoc[] +*** xref:discrete-titles.adoc[] +** xref:ids.adoc[] +*** xref:id-prefix-and-separator.adoc[] +** xref:custom-ids.adoc[] +** xref:numbers.adoc[] +** xref:styles.adoc[] +*** xref:special-section-titles.adoc[] +*** xref:special-section-numbers.adoc[] // Front matter -** xref:colophon.adoc[] -** xref:dedication.adoc[] +*** xref:colophon.adoc[] +*** xref:dedication.adoc[] // & Epigraph -** xref:abstract.adoc[] -** xref:preface.adoc[] -** xref:parts.adoc[] -*** xref:part-numbers-and-labels.adoc[] -** xref:chapters.adoc[] +*** xref:abstract.adoc[] +*** xref:preface.adoc[] +*** xref:parts.adoc[] +**** xref:part-numbers-and-labels.adoc[] +*** xref:chapters.adoc[] // Back matter -** xref:appendix.adoc[] -** xref:glossary.adoc[] -** xref:bibliography.adoc[] -** xref:index.adoc[] -* xref:section-ref.adoc[] +*** xref:appendix.adoc[] +*** xref:glossary.adoc[] +*** xref:bibliography.adoc[] +*** xref:index.adoc[] +** xref:section-ref.adoc[] diff --git a/modules/verbatim/nav.adoc b/modules/verbatim/nav.adoc index fd98e3c..79d6b0b 100644 --- a/modules/verbatim/nav.adoc +++ b/modules/verbatim/nav.adoc @@ -1,8 +1,8 @@ -.Verbatim and Source Blocks -* xref:source-blocks.adoc[] -** xref:source-highlighter.adoc[] -** xref:highlight-lines.adoc[] -** xref:highlight-php.adoc[] -* xref:listing-blocks.adoc[] -* xref:literal-blocks.adoc[] -* xref:callouts.adoc[] +* Verbatim and Source Blocks +** xref:source-blocks.adoc[] +*** xref:source-highlighter.adoc[] +*** xref:highlight-lines.adoc[] +*** xref:highlight-php.adoc[] +** xref:listing-blocks.adoc[] +** xref:literal-blocks.adoc[] +** xref:callouts.adoc[] -- GitLab