Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 07 Oct 2022 07:03:07 +0000
From:      bugzilla-noreply@freebsd.org
To:        doc@FreeBSD.org
Subject:   [Bug 266881] AsciiDoctor Primer: include more about macros
Message-ID:  <bug-266881-9@https.bugs.freebsd.org/bugzilla/>

next in thread | raw e-mail | index | archive | help
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D266881

            Bug ID: 266881
           Summary: AsciiDoctor Primer: include more about macros
           Product: Documentation
           Version: Latest
          Hardware: Any
               URL: https://github.com/freebsd/freebsd-doc/blob/main/docum
                    entation/content/en/books/fdp-primer/asciidoctor-prime
                    r/_index.adoc
                OS: Any
            Status: New
          Severity: Affects Some People
          Priority: ---
         Component: Books & Articles
          Assignee: doc@FreeBSD.org
          Reporter: grahamperrin@freebsd.org

Can the primer gain a list of available macros?=20

Also, for each one:=20

* context (not too complex)

* at least one example.=20

Thanks


Background
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D

<https://docs.freebsd.org/en/books/fdp-primer/asciidoctor-primer/#asciidoct=
or-links>
comprises two subsections:=20

* External links
* Internal link

=E2=80=93 no hint of how to form the special link to a page for a port.=20

For discovery, for an example, I browsed source code for part of the FreeBSD
Handbook.=20

Then, thanks to Pau Amma, I found my way to this:=20

<https://github.com/freebsd/freebsd-doc/blob/main/shared/lib/PackagesMacro/=
extension.rb>

=E2=80=93 for PackagesMacro, which, if I understand correctly, relates to=20
  the macro named:=20

    package

Example use:=20

    package:ports-mgmt/pkg[]

=E2=80=93 current result (cgit):=20

    <https://cgit.freebsd.org/ports/tree/ports-mgmt/pkg/pkg-descr>;

=E2=80=93 a three-word description.

--=20
You are receiving this mail because:
You are the assignee for the bug.=



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?bug-266881-9>