Skip to content
This repository has been archived by the owner on Mar 5, 2023. It is now read-only.

Commit

Permalink
DeveloperGuide: use labeled list for glossary
Browse files Browse the repository at this point in the history
The glossary uses literal blocks for formatting definitions, which looks
strange because literal blocks are usually used for preformatted text
such as source code.

Instead, let's use a labeled list, which has a formatting that is more
in line with a glossary definition list.

Convert the paragraph anchors into inline anchors[1], so that the items
are joined into one single labeled list with two items, rather than
being chopped into two separate labeled lists with one item each.

[1] See http://asciidoctor.org/docs/user-manual/#anchordef for the
    difference between a paragraph anchor and an inline anchor.
  • Loading branch information
pyokagan committed Dec 7, 2017
1 parent d63190e commit 3f0a1c1
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions docs/DeveloperGuide.adoc
Expand Up @@ -781,19 +781,11 @@ Use case resumes at step 2.
[appendix]
== Glossary

[[mainstream-os]]
Mainstream OS

....
[[mainstream-os]] Mainstream OS::
Windows, Linux, Unix, OS-X
....

[[private-contact-detail]]
Private contact detail

....
[[private-contact-detail]] Private contact detail::
A contact detail that is not meant to be shared with others
....

[appendix]
== Product Survey
Expand Down

0 comments on commit 3f0a1c1

Please sign in to comment.