summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2020-11-26 01:34:22 -0700
committerSarah White <graphitefriction@gmail.com>2020-12-08 14:32:53 -0700
commitddf574ba80c64d0c77dcd1f533aca874710907b4 (patch)
treefc65fe0020abaa5ae88775edf3c7049511d87400 /docs/modules
parent4d22dd41573291c1ab0a4a9bcb2602f3720ba62f (diff)
add additional explicit IDs to content
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/ROOT/pages/docinfo.adoc8
-rw-r--r--docs/modules/install/pages/linux-packaging.adoc5
-rw-r--r--docs/modules/install/pages/ruby-packaging.adoc3
3 files changed, 12 insertions, 4 deletions
diff --git a/docs/modules/ROOT/pages/docinfo.adoc b/docs/modules/ROOT/pages/docinfo.adoc
index 2c2cc28c..0c5959ff 100644
--- a/docs/modules/ROOT/pages/docinfo.adoc
+++ b/docs/modules/ROOT/pages/docinfo.adoc
@@ -87,7 +87,7 @@ See <<name-docinfo>> for more details.
To see a real-world example of a docinfo file for DocBook, checkout the {url-richfaces-docinfo}[RichFaces Developer Guide docinfo file^].
-[#footer-docinfo]
+[#footer]
== Footer docinfo files
Footer docinfo files are differentiated from head docinfo files by the addition of `-footer` to the file name.
@@ -104,7 +104,7 @@ To disable the "Last updated" line in the footer, unassign the attribute `last-u
To disable the footer completely, set the attribute `nofooter`. Then having a footer docinfo file effectively replaces the default footer with your custom footer.
////
-[#name-docinfo]
+[#naming]
== Naming docinfo files
The file that gets selected to provide the docinfo depends on which converter is in use (html, docbook, etc) and whether the docinfo scope is configured for a specific document ("`private`") or for all documents in the same directory ("`shared`").
@@ -134,7 +134,7 @@ The file extension of the docinfo file must match the file extension of the outp
|`docinfo-footer<outfilesuffix>`
|===
-[#enable-docinfo]
+[#enable]
== Enabling docinfo
To specify which file(s) you want to apply, set the `docinfo` attribute to any combination of these values:
@@ -186,6 +186,7 @@ You also want to include some additional content, but only to the head of [.path
If other AsciiDoc files are added to the same folder, and `docinfo` is set to `shared` in those files, only the [.path]_docinfo.html_ file will be added when converting those files.
+[#resolving]
== Locating docinfo files
By default, docinfo files are searched for in the same folder as the document file.
@@ -198,6 +199,7 @@ If you want to keep them anywhere else, set the `docinfodir` attribute to their
Note that if you use this attribute, only the specified folder will be searched; docinfo files in the document folder will no longer be found.
+[#attribute-substitution]
== Attribute substitution in docinfo files
Docinfo files may include attribute references.
diff --git a/docs/modules/install/pages/linux-packaging.adoc b/docs/modules/install/pages/linux-packaging.adoc
index 5df8c1f0..940fecf3 100644
--- a/docs/modules/install/pages/linux-packaging.adoc
+++ b/docs/modules/install/pages/linux-packaging.adoc
@@ -40,6 +40,7 @@ To install the package, open a terminal and type:
include::partial$success.adoc[]
+[#apk]
== apk (Alpine Linux)
To install the gem on Alpine Linux, open a terminal and type:
@@ -48,6 +49,7 @@ To install the gem on Alpine Linux, open a terminal and type:
include::partial$success.adoc[]
+[#pacman]
== pacman (Arch Linux)
To install the gem on Arch-based distributions, open a terminal and type:
@@ -65,18 +67,21 @@ If you need to upgrade to the latest version immediately, use xref:ruby-packagin
TIP: Your Linux system may be configured to automatically update packages, in which case the latest Asciidoctor package will be installed as soon as it becomes available.
No further action is required by you.
+[#upgrade-apt]
=== APT
On Debian and Debian-based distributions, update the Asciidoctor package using:
$ sudo apt-get upgrade -y asciidoctor
+[#upgrade-dnf]
=== DNF
On Fedora and other RPM-based distributions, you can update the package using:
$ sudo dnf update -y asciidoctor
+[#upgrade-apk]
=== apk (Alpine Linux)
On Alpine Linux, update the Asciidoctor package using:
diff --git a/docs/modules/install/pages/ruby-packaging.adoc b/docs/modules/install/pages/ruby-packaging.adoc
index ea9e0994..a07cfe16 100644
--- a/docs/modules/install/pages/ruby-packaging.adoc
+++ b/docs/modules/install/pages/ruby-packaging.adoc
@@ -41,13 +41,14 @@ gem 'asciidoctor'
To upgrade the gem, specify the new version in the Gemfile and run `bundle` again.
Using `bundle update` (without specifying a gem) is *not* recommended as it will also update other gems, which may not be the desired result.
+[#gem-update]
== Upgrade using gem update
[CAUTION]
====
You're advised against using the `gem update` command to update a gem managed by the package manager.
Doing so puts the system into an inconsistent state as the package manager can no longer track the files (which get installed under [.path]_/usr/local_).
-Simply put, system gems should only be managed by the package manager.
+Simply put, system gems should only be updated by the package manager.
If you want to use a version of Asciidoctor that is newer than what is installed by the package manager, you should use {url-rvm}[RVM^] to install Ruby in your home directory (i.e., user space).
Then, you can safely use the `gem` command to install or update the Asciidoctor gem.