aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/books/fdp-primer
diff options
context:
space:
mode:
authorSergio Carlavilla Delgado <carlavilla@FreeBSD.org>2021-11-03 16:39:08 +0000
committerSergio Carlavilla Delgado <carlavilla@FreeBSD.org>2021-11-03 16:44:52 +0000
commit64acd169b82416fe39ad8c4b1be106680d4a3eb3 (patch)
tree05b8bc3182dc4cfcf0a8a0964b4303903a4abf56 /documentation/content/en/books/fdp-primer
parent0636d709faeb6b7d1a44882ae33a02015d32774b (diff)
downloaddoc-64acd169b82416fe39ad8c4b1be106680d4a3eb3.tar.gz
doc-64acd169b82416fe39ad8c4b1be106680d4a3eb3.zip
Build offline documentation using Hugo and other improvements
* Allow to build the documentation offline using Hugo * Fix link problems * Remove SVN entities * Fix lang problems to help weblate * Move all the AsciiDoctor translations to the shared folder to help weblate * Allow the possibility to build each document. For example each document can be edited in and watched the result in real time in VS Code or Vim/NeoVim. Breaking changes: Eliminate the possibility of building books or articles. They must be builded at the same time. This functionality will be restored when version 0.89.0 is in the repositories in a couple of weeks. Reviewed by: dbaio@ Differential Revision: https://reviews.freebsd.org/D31926
Diffstat (limited to 'documentation/content/en/books/fdp-primer')
-rw-r--r--documentation/content/en/books/fdp-primer/_index.adoc28
-rw-r--r--documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc40
-rw-r--r--documentation/content/en/books/fdp-primer/book.adoc71
-rw-r--r--documentation/content/en/books/fdp-primer/doc-build/_index.adoc34
-rw-r--r--documentation/content/en/books/fdp-primer/editor-config/_index.adoc30
-rw-r--r--documentation/content/en/books/fdp-primer/examples/_index.adoc30
-rw-r--r--documentation/content/en/books/fdp-primer/manual-pages/_index.adoc32
-rw-r--r--documentation/content/en/books/fdp-primer/overview/_index.adoc35
-rw-r--r--documentation/content/en/books/fdp-primer/po-translations/_index.adoc44
-rw-r--r--documentation/content/en/books/fdp-primer/preface/_index.adoc31
-rw-r--r--documentation/content/en/books/fdp-primer/rosetta/_index.adoc30
-rw-r--r--documentation/content/en/books/fdp-primer/see-also/_index.adoc32
-rw-r--r--documentation/content/en/books/fdp-primer/structure/_index.adoc31
-rw-r--r--documentation/content/en/books/fdp-primer/tools/_index.adoc30
-rw-r--r--documentation/content/en/books/fdp-primer/translations/_index.adoc35
-rw-r--r--documentation/content/en/books/fdp-primer/working-copy/_index.adoc30
-rw-r--r--documentation/content/en/books/fdp-primer/writing-style/_index.adoc32
17 files changed, 447 insertions, 148 deletions
diff --git a/documentation/content/en/books/fdp-primer/_index.adoc b/documentation/content/en/books/fdp-primer/_index.adoc
index 4807dad36a..1b9ef9a0ec 100644
--- a/documentation/content/en/books/fdp-primer/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/_index.adoc
@@ -9,6 +9,7 @@ next: books/fdp-primer/preface
weight: 10
tags: ["FDP", "documentation", "FreeBSD", "Index"]
add_single_page_link: true
+isIndex: true
---
= FreeBSD Documentation Project Primer for New Contributors
@@ -18,7 +19,32 @@ add_single_page_link: true
:icons: font
:sectnums:
:sectnumlevels: 6
+:partnums:
+:source-highlighter: rouge
:experimental:
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+:chapters-path: content/{{% lang %}}/books/fdp-primer/
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+:chapters-path:
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+
+ifndef::env-beastie[]
+:chapters-path:
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
[.abstract-title]
Abstract
@@ -33,4 +59,4 @@ Corrections and additions are always welcome.
'''
-include::content/en/books/fdp-primer/toc.adoc[]
+include::{chapters-path}toc.adoc[]
diff --git a/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc b/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc
index 581d39aff6..85a4b6a4e0 100644
--- a/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/asciidoctor-primer/_index.adoc
@@ -14,17 +14,35 @@ tags: ["AsciiDoc", "AsciiDoctor", "Primer", "Introduction", "Guide"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 6
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 6
-
-include::shared/en/urls.adoc[]
-
-toc::[]
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+
+ifndef::env-beastie[]
+toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
Most FDP documentation is written with AsciiDoc.
This chapter explains what that means, how to read and understand the documentation source, and the techniques used.
@@ -212,12 +230,12 @@ For example, if we are in the `cups` article and we want to point to `ipsec-must
. Then create a link using the AsciiDoctor variable to the `ipsec-must` article.
+
....
-link:{ipsec-must}[IPSec-Must article]
+extref:{ipsec-must}[IPSec-Must article]
....
+
And this would be rendered as.
+
-link:{ipsec-must}[IPSec-Must article]
+extref:{ipsec-must}[IPSec-Must article]
[[asciidoctor-conclusion]]
== Conclusion
diff --git a/documentation/content/en/books/fdp-primer/book.adoc b/documentation/content/en/books/fdp-primer/book.adoc
index aec895e083..71ef597575 100644
--- a/documentation/content/en/books/fdp-primer/book.adoc
+++ b/documentation/content/en/books/fdp-primer/book.adoc
@@ -14,48 +14,35 @@ add_split_page_link: true
:toc: macro
:toclevels: 2
:icons: font
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
:sectnums:
:sectnumlevels: 6
:partnums:
-:chapter-signifier: Chapter
-:part-signifier: Part
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
:book: true
:pdf: false
+:images-path: books/fdp-primer/
-ifeval::["{backend}" == "html5"]
-include::shared/mirrors.adoc[]
+ifdef::env-beastie[]
+ifdef::backend-html5[]
include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
include::shared/releases.adoc[]
-include::shared/en/mailing-lists.adoc[]
-include::shared/en/teams.adoc[]
-include::shared/en/urls.adoc[]
-:chapters-path: content/en/books/fdp-primer/
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+:chapters-path: content/{{% lang %}}/books/fdp-primer/
endif::[]
-
-ifeval::["{backend}" == "pdf"]
-include::../../../../shared/mirrors.adoc[]
-include::../../../../shared/authors.adoc[]
-include::../../../../shared/releases.adoc[]
-include::../../../../shared/en/mailing-lists.adoc[]
-include::../../../../shared/en/teams.adoc[]
-include::../../../../shared/en/urls.adoc[]
+ifdef::backend-pdf,backend-epub3[]
:chapters-path:
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
endif::[]
-ifeval::["{backend}" == "epub3"]
-include::../../../../shared/mirrors.adoc[]
-include::../../../../shared/authors.adoc[]
-include::../../../../shared/releases.adoc[]
-include::../../../../shared/en/mailing-lists.adoc[]
-include::../../../../shared/en/teams.adoc[]
-include::../../../../shared/en/urls.adoc[]
+ifndef::env-beastie[]
:chapters-path:
+include::../../../../../shared/asciidoctor.adoc[]
endif::[]
[.abstract-title]
@@ -79,38 +66,38 @@ include::{chapters-path}toc-examples.adoc[]
:sectnums!:
-include::{chapters-path}preface/_index.adoc[leveloffset=+1, lines=9..-1]
+include::{chapters-path}preface/_index.adoc[leveloffset=+1]
:sectnums:
-include::{chapters-path}overview/_index.adoc[leveloffset=+1, lines=9..23; 30..-1]
+include::{chapters-path}overview/_index.adoc[leveloffset=+1]
-include::{chapters-path}tools/_index.adoc[leveloffset=+1, lines=9..23; 27..-1]
+include::{chapters-path}tools/_index.adoc[leveloffset=+1]
-include::{chapters-path}working-copy/_index.adoc[leveloffset=+1, lines=9..23; 27..-1]
+include::{chapters-path}working-copy/_index.adoc[leveloffset=+1]
-include::{chapters-path}structure/_index.adoc[leveloffset=+1, lines=9..23; 27..-1]
+include::{chapters-path}structure/_index.adoc[leveloffset=+1]
-include::{chapters-path}doc-build/_index.adoc[leveloffset=+1, lines=9..23; 27..-1]
+include::{chapters-path}doc-build/_index.adoc[leveloffset=+1]
-include::{chapters-path}asciidoctor-primer/_index.adoc[leveloffset=+1, lines=9..23; 29..-1]
+include::{chapters-path}asciidoctor-primer/_index.adoc[leveloffset=+1]
-include::{chapters-path}rosetta/_index.adoc[leveloffset=+1, lines=9..23; 27..-1]
+include::{chapters-path}rosetta/_index.adoc[leveloffset=+1]
-include::{chapters-path}translations/_index.adoc[leveloffset=+1, lines=9..23; 30..-1]
+include::{chapters-path}translations/_index.adoc[leveloffset=+1]
-include::{chapters-path}po-translations/_index.adoc[leveloffset=+1, lines=9..23; 29..-1]
+include::{chapters-path}po-translations/_index.adoc[leveloffset=+1]
-include::{chapters-path}manual-pages/_index.adoc[leveloffset=+1, lines=9..23; 27..-1]
+include::{chapters-path}manual-pages/_index.adoc[leveloffset=+1]
-include::{chapters-path}writing-style/_index.adoc[leveloffset=+1, lines=9..23; 29..-1]
+include::{chapters-path}writing-style/_index.adoc[leveloffset=+1]
-include::{chapters-path}editor-config/_index.adoc[leveloffset=+1, lines=9..23; 27..-1]
+include::{chapters-path}editor-config/_index.adoc[leveloffset=+1]
-include::{chapters-path}see-also/_index.adoc[leveloffset=+1, lines=9..23; 29..-1]
+include::{chapters-path}see-also/_index.adoc[leveloffset=+1]
:sectnums!:
-include::{chapters-path}examples/_index.adoc[leveloffset=+1, lines=8..23; 27..-1]
+include::{chapters-path}examples/_index.adoc[leveloffset=+1]
:sectnums:
diff --git a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
index c39adf8a40..8f52e7d9b5 100644
--- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
@@ -14,15 +14,35 @@ tags: ["build", "process", "make"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 5
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 5
-
-toc::[]
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+
+ifndef::env-beastie[]
+toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
This chapter covers organization of the documentation build process and how man:make[1] is used to control it.
diff --git a/documentation/content/en/books/fdp-primer/editor-config/_index.adoc b/documentation/content/en/books/fdp-primer/editor-config/_index.adoc
index 59ecbedc51..d86acd279f 100644
--- a/documentation/content/en/books/fdp-primer/editor-config/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/editor-config/_index.adoc
@@ -14,15 +14,35 @@ tags: ["editor", "configuration", "vim", "emacs", "FreeBSD"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 12
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 12
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+ifndef::env-beastie[]
toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
Adjusting your text editor configuration can make working on document files quicker and easier, and help documents conform to FDP guidelines.
diff --git a/documentation/content/en/books/fdp-primer/examples/_index.adoc b/documentation/content/en/books/fdp-primer/examples/_index.adoc
index 430c80c9eb..d1e1acb004 100644
--- a/documentation/content/en/books/fdp-primer/examples/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/examples/_index.adoc
@@ -14,15 +14,35 @@ tags: ["examples", "tutorial", "AsciiDoctor", "Book", "Article"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: A
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: A
+:images-path: books/fdp-primer/
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+
+ifndef::env-beastie[]
+toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
These examples are not exhaustive - they do not contain all the elements that might be desirable to use, particularly in a document's front matter.
For more examples of AsciiDoctor, examine the AsciiDoc source for this and other documents available in the Git `doc` repository, or available online starting at link:https://cgit.freebsd.org/doc/[https://cgit.freebsd.org/doc/].
diff --git a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc
index 36b078781c..86b8a336ec 100644
--- a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc
@@ -14,15 +14,35 @@ tags: ["manual pages", "introduction", "guide", "reference"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 10
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 10
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+ifndef::env-beastie[]
toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
[[manual-pages-introduction]]
== Introduction
@@ -249,7 +269,7 @@ A trivial example shows the minimal requirements, a serious example shows actual
Include the BSD license::
Include the BSD license on new manual pages.
-The preferred license is available from the link:{committers-guide}[Committer's Guide].
+The preferred license is available from the extref:{committers-guide}[Committer's Guide].
[[manual-pages-markup-tricks]]
=== Markup Tricks
diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc
index d273ee34ae..42af65e795 100644
--- a/documentation/content/en/books/fdp-primer/overview/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc
@@ -14,18 +14,35 @@ tags: ["overview", "FreeBSD Documentation Project", "quick start"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 1
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 1
-
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
include::shared/releases.adoc[]
-include::shared/en/mailing-lists.adoc[]
-
-toc::[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+
+ifndef::env-beastie[]
+toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
Welcome to the FreeBSD Documentation Project (FDP).
Quality documentation is crucial to the success of FreeBSD, and we value your contributions very highly.
diff --git a/documentation/content/en/books/fdp-primer/po-translations/_index.adoc b/documentation/content/en/books/fdp-primer/po-translations/_index.adoc
index 7e33cf1742..3783dcd2ba 100644
--- a/documentation/content/en/books/fdp-primer/po-translations/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/po-translations/_index.adoc
@@ -14,17 +14,35 @@ tags: ["po", "translations", "tutorial", "quick start"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 9
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 9
-
-include::shared/en/urls.adoc[]
-
-toc::[]
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+
+ifndef::env-beastie[]
+toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
[[po-translations-introduction]]
== Introduction
@@ -40,7 +58,7 @@ The strings can be used directly or built into a complete translated version of
The procedure shown in crossref:overview[overview-quick-start,Quick Start] is assumed to have already been performed.
The `TRANSLATOR` option is required and already enabled by default in the package:textproc/docproj[] port.
-This example shows the creation of a Spanish translation of the short link:{leap-seconds}[Leap Seconds] article.
+This example shows the creation of a Spanish translation of the short extref:{leap-seconds}[Leap Seconds] article.
[[po-translations-quick-start-install-po-editor]]
@@ -255,7 +273,7 @@ If the language directory already exists, only a subdirectory in the [.filename]
.Creating a Spanish Translation of the Porter's Handbook
[example]
====
-Create a new Spanish translation of the link:{porters-handbook}[Porter's Handbook].
+Create a new Spanish translation of the extref:{porters-handbook}[Porter's Handbook].
The original is a book in [.filename]#~/doc/documentation/content/en/books/porters-handbook/#.
[.procedure]
@@ -350,7 +368,7 @@ English original:
....
msgid ""
"This example shows the creation of a Spanish translation of the short "
-"link:{leap-seconds}[Leap Seconds] article."
+"extref:{leap-seconds}[Leap Seconds] article."
....
Spanish translation:
@@ -359,7 +377,7 @@ Spanish translation:
....
msgid ""
"Este ejemplo muestra la creación de un artículo con poco contenido como el artículo "
-"link:{leap-seconds}[Leap Seconds]."
+"extref:{leap-seconds}[Leap Seconds]."
....
====
diff --git a/documentation/content/en/books/fdp-primer/preface/_index.adoc b/documentation/content/en/books/fdp-primer/preface/_index.adoc
index 99859c1df7..7a46dacfed 100644
--- a/documentation/content/en/books/fdp-primer/preface/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/preface/_index.adoc
@@ -1,6 +1,6 @@
---
title: Preface
-prev: books/fdp-primer/
+prev: books/fdp-primer
next: books/fdp-primer/overview
description: Preface about the FreeBSD Documentation Project
tags: ["preface", "prompts", "conventions"]
@@ -15,10 +15,31 @@ tags: ["preface", "prompts", "conventions"]
:icons: font
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+
+ifndef::env-beastie[]
+toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
[[preface-prompts]]
== Shell Prompts
diff --git a/documentation/content/en/books/fdp-primer/rosetta/_index.adoc b/documentation/content/en/books/fdp-primer/rosetta/_index.adoc
index 54437cb282..2c023b330f 100644
--- a/documentation/content/en/books/fdp-primer/rosetta/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/rosetta/_index.adoc
@@ -14,15 +14,35 @@ tags: ["rosetta", "docbook", "asciidoc", "comparison"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 7
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 7
+:images-path: books/fdp-primer/
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+
+ifndef::env-beastie[]
+toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
[[docbook-vs-asciidoc]]
== Comparison between Docbook and AsciiDoc
diff --git a/documentation/content/en/books/fdp-primer/see-also/_index.adoc b/documentation/content/en/books/fdp-primer/see-also/_index.adoc
index 410d384b27..7caa0701d5 100644
--- a/documentation/content/en/books/fdp-primer/see-also/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/see-also/_index.adoc
@@ -14,17 +14,35 @@ tags: ["additional information", "AsciiDoctor", "HTML"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 13
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 13
+:images-path: books/fdp-primer/
-include::shared/en/urls.adoc[]
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+ifndef::env-beastie[]
toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
This document is deliberately not an exhaustive discussion of AsciiDoc and the FreeBSD Documentation Project.
For more information about these, you are encouraged to see the following web sites.
@@ -33,7 +51,7 @@ For more information about these, you are encouraged to see the following web si
== The FreeBSD Documentation Project
* link:https://www.FreeBSD.org/docproj/[The FreeBSD Documentation Project web pages]
-* link:{handbook}[The FreeBSD Handbook]
+* extref:{handbook}[The FreeBSD Handbook]
[[see-also-asciidoc]]
== AsciiDoctor
diff --git a/documentation/content/en/books/fdp-primer/structure/_index.adoc b/documentation/content/en/books/fdp-primer/structure/_index.adoc
index 6eaf0403cc..742d5d1583 100644
--- a/documentation/content/en/books/fdp-primer/structure/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/structure/_index.adoc
@@ -14,15 +14,35 @@ tags: ["directory structure", "organization"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 4
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 4
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+ifndef::env-beastie[]
toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
Files and directories in the [.filename]#doc/# tree follow a structure meant to:
@@ -223,7 +243,6 @@ title: Why you should use a BSD style license for your Open Source Project
authors:
- author: Bruce Montague
email: brucem@alumni.cse.ucsc.edu
-releaseinfo: "$FreeBSD$"
trademarks: ["freebsd", "intel", "general"]
---
diff --git a/documentation/content/en/books/fdp-primer/tools/_index.adoc b/documentation/content/en/books/fdp-primer/tools/_index.adoc
index a5acaf0859..4158d57897 100644
--- a/documentation/content/en/books/fdp-primer/tools/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/tools/_index.adoc
@@ -14,15 +14,35 @@ tags: ["tools", "required tools", "optional tools"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 2
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 2
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+ifndef::env-beastie[]
toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
Several software tools are used to manage the FreeBSD documentation and render it to different output formats.
Some of these tools are required and must be installed before working through the examples in the following chapters.
diff --git a/documentation/content/en/books/fdp-primer/translations/_index.adoc b/documentation/content/en/books/fdp-primer/translations/_index.adoc
index 118c0a980f..8bcbf5b77e 100644
--- a/documentation/content/en/books/fdp-primer/translations/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/translations/_index.adoc
@@ -14,18 +14,35 @@ tags: ["FAQ", "i18n", "i10n", "translation"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 8
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 8
-
-include::shared/en/teams.adoc[]
-include::shared/en/mailing-lists.adoc[]
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+ifndef::env-beastie[]
toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
This is the FAQ for people translating the FreeBSD documentation (FAQ, Handbook, tutorials, manual pages, and others) to different languages.
@@ -87,7 +104,7 @@ For example, to view the differences between revisions `abff932fe8` and `2191c44
% git diff abff932fe8 2191c44469 documentation/content/en/articles/committers-guide/_index.adoc
....
-Please see the complete explanation of using Git in FreeBSD in the link:{handbook}mirrors/#git[FreeBSD Handbook].
+Please see the complete explanation of using Git in FreeBSD in the extref:{handbook}mirrors[FreeBSD Handbook, git].
== How do I find out who else might be translating to the same language?
diff --git a/documentation/content/en/books/fdp-primer/working-copy/_index.adoc b/documentation/content/en/books/fdp-primer/working-copy/_index.adoc
index 5b167694a4..56dedf08d7 100644
--- a/documentation/content/en/books/fdp-primer/working-copy/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/working-copy/_index.adoc
@@ -14,15 +14,35 @@ tags: ["working copy", "documentation", "manual pages", "git"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 3
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 3
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+ifndef::env-beastie[]
toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
The _working copy_ is a copy of the FreeBSD repository documentation tree downloaded onto the local computer.
Changes are made to the local working copy, tested, and then submitted as patches to be committed to the main repository.
diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc
index e6f19cd197..9e3321bbae 100644
--- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc
@@ -14,17 +14,35 @@ tags: ["writing", "style", "tipos", "one sentence per line"]
:icons: font
:sectnums:
:sectnumlevels: 6
+:sectnumoffset: 11
+:partnums:
:source-highlighter: rouge
:experimental:
-:skip-front-matter:
-:xrefstyle: basic
-:relfileprefix: ../
-:outfilesuffix:
-:sectnumoffset: 11
-
-include::shared/en/mailing-lists.adoc[]
+:images-path: books/fdp-primer/
+
+ifdef::env-beastie[]
+ifdef::backend-html5[]
+:imagesdir: ../../../../images/{images-path}
+endif::[]
+ifndef::book[]
+include::shared/authors.adoc[]
+include::shared/mirrors.adoc[]
+include::shared/releases.adoc[]
+include::shared/attributes/attributes-{{% lang %}}.adoc[]
+include::shared/{{% lang %}}/teams.adoc[]
+include::shared/{{% lang %}}/mailing-lists.adoc[]
+include::shared/{{% lang %}}/urls.adoc[]
+toc::[]
+endif::[]
+ifdef::backend-pdf,backend-epub3[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
+endif::[]
+ifndef::env-beastie[]
toc::[]
+include::../../../../../shared/asciidoctor.adoc[]
+endif::[]
[[writing-style-tips]]
== Tips