sdpi-article-asciidoc-cheat-sheet.adoc

SDPi Editors AsciiDoc Cheat Sheet

Contents

• 1. 'Sup with this "Cheat Sheet"?
• 2. Document Stuff
• 3. Blocks Stuff
• 4. Reference Stuff
• 5. Text Formatting Stuff
• 6. Table Stuff
• 7. Parking Lot Stuff

Warning

This is a straw-man article. Content hackers welcomed! Add issues to the Chapter 7 section.

1. 'Sup with this "Cheat Sheet"?

Though the article IHE Technical Framework / SDPi Content in AsciiDoc covers AsciiDoc application to specific content needs of the SDPi supplement, for those who are just getting started with the language, figuring out where the basics (and advanced) usage is documented is …​ challenging.

This quick reference guide helps cover that space between the content conventions and the actual AsciiDoc language. For more detailed information on the AsciiDoc use conventions, see the article IHE TF / SDPi AsciiDoc Cookbook.

The document links are generally to Asciidoctor Docs online documentation.

2. Document Stuff

Add: Process basics: AsciiDoc source ⇒ AsciiDoctor processor ⇒ convert to published format (HTML) Add: Line oriented / stacks of blocks (starting with block=line)

3. Blocks Stuff

ADD: Basic blocks references ADD: References for types of blocks ADD:

4. Reference Stuff

Add: [#xuze, reftext=YIKES] Add: :attribute: value pairs Add: macro::name() …​ e.g., image::AFCisGreat.png(…​)

5. Text Formatting Stuff

ADD: Admonitions ADD: So you want to indent do you …​ good luck!

6. Table Stuff

ADD: Basic table references ADD: Table formatting examples (alignment, spanning, …​)

7. Parking Lot Stuff

(in no particular order)

• admonitions

• indenting

• empty lines

• Table Formatting

• attributes

• references

• anchors

• Tables from Files (CSV, TSV, DSV)

• …​