All wiki documents use these header attributes. Optional attributes can be left blank following the : colon symbol.
= Enter Document Title Here :author: :revnumber: :revdate: :relfileprefix: ../../ :imagesdir: ../.. :experimental: ifdef::env-github,env-browser[:outfilesuffix: .adoc]
= Mandatory. Title of your document.
:author: Optional. Document author.
:revnumber: Optional. Revision number.
:revdate: Optional. Revision Date
:relfileprefix: Mandatory. Enter a path to the “asciidoc” folder.
In the example below, “asciidoc” is two folders above the folder this file is located in.
:imagesdir: Mandatory. Enter a path to the "images" folder.
In the example below, “images” is two folders above the folder this file is located in. Note the missing / forward slash.
A simple way to determine the location of the "asciidoc" and "images" folder in the Atom editor is first save the file to its new location, then in
Temporarily paste this into your document to see where the “asciidoc” folder is located.
In this example, "asciidoc" is located two folders above the "advanced" folder
You can find this same folder information using GitHub.
The “images” folder resides in the same folder as the “asciidoc” folder so it has the same setting minus the / forward slash.
:experimental: Leave this blank. This is the experimental attribute that allows the use of User Interface Macros. You use these macros for creating keyboard shortcuts, displaying menu selections and UI buttons.
ifdef::env-github,env-browser[:outfilesuffix: .adoc] See Navigating Between Source Files in the AsciiDoctor user manual. Leave this as written.