Contributor guide navtitles added

PeterTurcan · alandefreitas · commit 466f2d0d05e8 · 2023-05-02T15:19:40.000-03:00
diff --git a/contributor-guide/modules/ROOT/nav.adoc b/contributor-guide/modules/ROOT/nav.adoc
@@ -1,23 +1,23 @@
 
 
-* xref:intro.adoc[Introduction to becoming a Boost Contributor]
-** xref:license-requirements.adoc[License Requirements]
-** xref:portability-requirements.adoc[Portability Requirements]
-** xref:organization-requirements.adoc[Organization Requirements]
-** xref:library-design-guidelines.adoc[Library Design Guidelines]
+* xref:intro.adoc[]
+** xref:license-requirements.adoc[]
+** xref:portability-requirements.adoc[]
+** xref:organization-requirements.adoc[]
+** xref:library-design-guidelines.adoc[]
 * xref:antora.adoc[Antora Guide]
 * Legacy Content
-** xref:documentation-overview.adoc[Writing Documentation for Boost - Documentation Structure]
-** xref:documentation-structure-guidelines.adoc[Boost Library Documentation Guidelines]
+** xref:documentation-overview.adoc[]
+** xref:documentation-structure-guidelines.adoc[]
 ** Templates
-*** xref:templates/01-overview-template.adoc[Overview Template]
-*** xref:templates/02-header-template.adoc[Header Template]
-*** xref:templates/03-configuration-template.adoc[Configuration Template]
-*** xref:templates/04-rationale-template.adoc[Rationale Template]
-*** xref:templates/05-definitions-template.adoc[Definitions Template]
-*** xref:templates/06-faq-template.adoc[FAQ Template]
-*** xref:templates/07-bibliography-template.adoc[Bibliography Template]
-*** xref:templates/08-acknowledgements-template.adoc[Acknowledgments Template]
+*** xref:templates/01-overview-template.adoc[]
+*** xref:templates/02-header-template.adoc[]
+*** xref:templates/03-configuration-template.adoc[]
+*** xref:templates/04-rationale-template.adoc[]
+*** xref:templates/05-definitions-template.adoc[]
+*** xref:templates/06-faq-template.adoc[]
+*** xref:templates/07-bibliography-template.adoc[]
+*** xref:templates/08-acknowledgements-template.adoc[]
 
 
 
diff --git a/contributor-guide/modules/ROOT/pages/documentation-overview.adoc b/contributor-guide/modules/ROOT/pages/documentation-overview.adoc
@@ -1,4 +1,5 @@
 = Writing Documentation for Boost - Documentation Structure
+:navtitle: Standards Documentation Structure
 
 == Introduction
 
diff --git a/contributor-guide/modules/ROOT/pages/documentation-structure-guidelines.adoc b/contributor-guide/modules/ROOT/pages/documentation-structure-guidelines.adoc
@@ -1,4 +1,5 @@
 = Boost Library Documentation Guidelines
+:navtitle: General Documentation Guidelines
 
 It is not a requirement for a Boost library for the documentation to adhere to the following structure. However, it is listed here as a guide, if needed.
 
diff --git a/contributor-guide/modules/ROOT/pages/intro.adoc b/contributor-guide/modules/ROOT/pages/intro.adoc
@@ -1,4 +1,5 @@
 = Introduction to becoming a Boost Contributor
+:navtitle: Becoming a Boost Contributor
 
 This section describes the requirements and guidelines for the content of a library submitted to Boost.
 
diff --git a/contributor-guide/modules/ROOT/pages/library-design-guidelines.adoc b/contributor-guide/modules/ROOT/pages/library-design-guidelines.adoc
@@ -1,4 +1,5 @@
 = Library Design Guidelines
+:navtitle: Library Design Guidelines
 
 Please use these guidelines as a checklist for preparing the content a library submission. Not every guideline applies to every library, but a reasonable effort to comply is expected.
 
diff --git a/contributor-guide/modules/ROOT/pages/license-requirements.adoc b/contributor-guide/modules/ROOT/pages/license-requirements.adoc
@@ -1,4 +1,5 @@
 = License Requirements
+:navtitle: License Requirements
 
 The preferred way to meet the license requirements is to use the https://www.boost.org/LICENSE_1_0.txt[Boost Software License]. See license information. If for any reason you do not intend to use the Boost Software License, please discuss the issues on the Boost developers mailing list first.
 
diff --git a/contributor-guide/modules/ROOT/pages/organization-requirements.adoc b/contributor-guide/modules/ROOT/pages/organization-requirements.adoc
@@ -1,4 +1,5 @@
 = Organization Requirements
+:navtitle: Organization Requirements
 
 The quality of the Boost libraries is not just about the APIs and code design. But also about presenting a consistent view to users of the libraries as a whole. Upon acceptance libraries must adhere to this directory and file structure:
 
diff --git a/contributor-guide/modules/ROOT/pages/portability-requirements.adoc b/contributor-guide/modules/ROOT/pages/portability-requirements.adoc
@@ -1,4 +1,5 @@
 = Portability Requirements
+:navtitle: Portability Requirements
 
 * A library's interface must be portable and not restricted to a particular compiler or operating system.
 * A library's implementation must if possible be portable and not restricted to a particular compiler or operating system. If a portable implementation is not possible, non-portable constructions are acceptable if reasonably easy to port to other environments, and implementations are provided for at least two popular operating systems (such as UNIX and Windows).
diff --git a/contributor-guide/modules/ROOT/pages/templates/01-overview-template.adoc b/contributor-guide/modules/ROOT/pages/templates/01-overview-template.adoc
@@ -1,4 +1,5 @@
 = Overview Template
+:navtitle: Overview
 
 Provide a brief overview of the focus and features of your library.
 
diff --git a/contributor-guide/modules/ROOT/pages/templates/02-header-template.adoc b/contributor-guide/modules/ROOT/pages/templates/02-header-template.adoc
@@ -1,4 +1,5 @@
 = Header Template
+:navtitle: Header
 
 Provide a complete API reference to your library.
 
diff --git a/contributor-guide/modules/ROOT/pages/templates/03-configuration-template.adoc b/contributor-guide/modules/ROOT/pages/templates/03-configuration-template.adoc
@@ -1,4 +1,5 @@
 = Configuration Template
+:navtitle: Configuration
 
 Describe the configuration macros that are used in your library.
 
@@ -19,9 +20,9 @@ http://www.boost.org/libs/config/config.htm[<boost/config.hpp>], as well as conf
 These are the macros that may be defined by an application using
 `<LibraryName>`.
 
-[cols="1,2"]
+[cols="1,2",options="header",stripes=even]
 |===
-|*Macro* |*Meaning*
+| Macro  | Meaning
 |`macro` |meaning text
 |`macro` |meaning text
 |===
@@ -30,9 +31,9 @@ These are the macros that may be defined by an application using
 
 These macros are defined by `<LibraryName>`, but are expected to be used by application code.
 
-[cols="1,2"]
+[cols="1,2",options="header",stripes=even]
 |===
-|*Macro* |*Meaning*
+| Macro  | Meaning
 |`macro` |meaning text
 |`macro` |meaning text
 |===
@@ -41,9 +42,9 @@ These macros are defined by `<LibraryName>`, but are expected to be used by appl
 
 These macros are defined by `<LibraryName>` and are implementation details of interest only to implementers.
 
-[cols="1,2"]
+[cols="1,2",options="header",stripes=even]
 |===
-|*Macro* |*Meaning*
+| Macro  | Meaning
 |`macro` |meaning text
 |`macro` |meaning text
 |===
@@ -57,9 +58,9 @@ These macros are defined by `<LibraryName>` and are implementation details of in
 These are the macros that may be defined by an application using
 `<LibraryName>`.
 
-[cols="1,2"]
+[cols="1,2",options="header",stripes=even]
 |===
-|*Macro* |*Meaning*
+| Macro  | Meaning
 |`add(x,y)` | The x and y values are added together.
 |`mult(x,y)` | The x and Y values are multiplied together.
 |===
diff --git a/contributor-guide/modules/ROOT/pages/templates/04-rationale-template.adoc b/contributor-guide/modules/ROOT/pages/templates/04-rationale-template.adoc
@@ -1,4 +1,5 @@
 =  Rationale Template
+:navtitle: Rationale
 
 A Rationale provides a description of the motivation behind the library. Describe the current problems that exist, and the goals of the library in addressing those problems.
 
diff --git a/contributor-guide/modules/ROOT/pages/templates/05-definitions-template.adoc b/contributor-guide/modules/ROOT/pages/templates/05-definitions-template.adoc
@@ -1,4 +1,5 @@
 = Definitions Template
+:navtitle: Definitions
 
 If you library uses any terminology that might benefit from a description, consider adding Definitions to your documentation.
 
diff --git a/contributor-guide/modules/ROOT/pages/templates/06-faq-template.adoc b/contributor-guide/modules/ROOT/pages/templates/06-faq-template.adoc
@@ -1,4 +1,5 @@
 = Frequently Asked Questions (FAQs) Template
+:navtitle: FAQ
 
 If a Frequently Asked Questions (FAQ) would add value to your documentation, by aiding developers with answers to known issues or complexities, then copy the source below into your AsciiDocs source documentation.
 
diff --git a/contributor-guide/modules/ROOT/pages/templates/07-bibliography-template.adoc b/contributor-guide/modules/ROOT/pages/templates/07-bibliography-template.adoc
@@ -1,4 +1,5 @@
 = Bibliography Template
+:navtitle: Bibliography
 
 If bibliographic references are required in your documentation for your library, add a bibliography to the documentation.
 
diff --git a/contributor-guide/modules/ROOT/pages/templates/08-acknowledgements-template.adoc b/contributor-guide/modules/ROOT/pages/templates/08-acknowledgements-template.adoc
@@ -1,4 +1,5 @@
 = Acknowledgements Template
+:navtitle: Acknowledgements
 
 If acknowledgements are required for your library, add an acknowledgements section to the documentation. As a rule of thumb, the acknowledgements should be ordered with the most important contributions coming first. Links can be included, if required.
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Writing Documentation for Boost - Documentation Structure`
	`2`	`+:navtitle: Standards Documentation Structure`
`2`	`3`
`3`	`4`	`== Introduction`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Boost Library Documentation Guidelines`
	`2`	`+:navtitle: General Documentation Guidelines`
`2`	`3`
`3`	`4`	`It is not a requirement for a Boost library for the documentation to adhere to the following structure. However, it is listed here as a guide, if needed.`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Introduction to becoming a Boost Contributor`
	`2`	`+:navtitle: Becoming a Boost Contributor`
`2`	`3`
`3`	`4`	`This section describes the requirements and guidelines for the content of a library submitted to Boost.`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Library Design Guidelines`
	`2`	`+:navtitle: Library Design Guidelines`
`2`	`3`
`3`	`4`	`Please use these guidelines as a checklist for preparing the content a library submission. Not every guideline applies to every library, but a reasonable effort to comply is expected.`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= License Requirements`
	`2`	`+:navtitle: License Requirements`
`2`	`3`
`3`	`4`	`The preferred way to meet the license requirements is to use the https://www.boost.org/LICENSE_1_0.txt[Boost Software License]. See license information. If for any reason you do not intend to use the Boost Software License, please discuss the issues on the Boost developers mailing list first.`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Organization Requirements`
	`2`	`+:navtitle: Organization Requirements`
`2`	`3`
`3`	`4`	`The quality of the Boost libraries is not just about the APIs and code design. But also about presenting a consistent view to users of the libraries as a whole. Upon acceptance libraries must adhere to this directory and file structure:`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Portability Requirements`
	`2`	`+:navtitle: Portability Requirements`
`2`	`3`
`3`	`4`	`* A library's interface must be portable and not restricted to a particular compiler or operating system.`
`4`	`5`	`* A library's implementation must if possible be portable and not restricted to a particular compiler or operating system. If a portable implementation is not possible, non-portable constructions are acceptable if reasonably easy to port to other environments, and implementations are provided for at least two popular operating systems (such as UNIX and Windows).`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Overview Template`
	`2`	`+:navtitle: Overview`
`2`	`3`
`3`	`4`	`Provide a brief overview of the focus and features of your library.`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`= Header Template`
	`2`	`+:navtitle: Header`
`2`	`3`
`3`	`4`	`Provide a complete API reference to your library.`
`4`	`5`