adoc(9)

SYNOPSIS

asciidoc, adoc - AsciiDoc Markup File.

FILES

hkadoc.emf - AsciiDoc file hook definition
adoc.eaf - AsciiDoc abbreviation file
adoc.etf - AsciiDoc template file

EXTENSIONS

.asciidoc, .adoc, .tdoc - AsciiDoc files

MAGIC STRINGS

-!- asciidoc -!-


MicroEmacs recognizes the magic string on any of the first 4 lines of the file. The HTML files may be extension-less and are still recognized.

DESCRIPTION

The AsciiDoc file hook provides a editing environment for AsciiDoc files. The file hook provides highlighting, folding of sections, document outline using item-list and abbreviations.

File recognition is performed using the standard file extension .adoc, .adoc or .tdoc or by the magic string. The .tdoc extension indicates that there are non-AscciDoc based extensions for instance to embed code of other programming languages like R or Tcl within the file which needs to be processed with tools like tmdoc before the document can be compiled with the Asciidoc compiler.

Abbreviations


The installation comes with a default abbreviation file for AsciiDoc code editing which can be used by writing short abbreviations like "fig" for a figure environment, "bib" for a bibliography file, "img" for an image file, or "co" for a code chunk - and then pressing the key-binding for the expand-abbrev-handle(3) command. The list of abbreviations can be used interactively in the GUI version of MicroEmacs using the abbrev-list(3) command.

Folding and Information Hiding


Generic folding is enabled within the AsciiDoc files. The folds occur about the level 1 and 2 headers, so headers with one or two equal symbols at the beginning of a line. The following commands are supported to show and hide the function bodies. collapse-all(3) (un)folds all regions in the file, collapse-current(3) (un)folds the current region.

List Items


Item listing is available for level 1 and 2 headers as well as for lines starting with TODO. These items of the file are displayed using the the item-list command.

Short Cuts


The short cut keys used within the buffer are:-

C-c C-c - Comment out the current line.
C-c C-d - Uncomment the current line.
f2 - (un)fold the current region
f3 - (un)fold all regions
f6 - list items
esc f6 - close list items

SEE ALSO

abbrev-list(3), collapse-all(3), collapse-current(3), expand-abbrev-handle(3), item-list(3), md(9), typst(9), wiki(9)

Supported File Types

(c) Copyright JASSPA 2025
Last Modified: 2025/10/20
Generated On: 2025/12/01