asciidoc.adoc

Scanner for Asciidoc files

Scanner for Asciidoc files

Accepts files with ".adoc" suffix and puts the AsciidoctorJ AST into the jQAssistant database. Note: needs a recent version of AsciidoctorJ and re-uses the jQAssistant dependency to prevent runtime version conflicts. This means, only jQAssistant 1.2+ will work with this plugin.

Table 1. Configuration parameters

Name	Description
jqassistant.plugin.asciidoc.suffixes	Optional: comma separated list of suffixes of files to be accepted, e.g. "adoc, asciidoc". Default: "adoc, asciidoc"

:Asciidoc:File

Table 2. Properties

Name	Description
name	The file name.
fileName	The absolute file name.

Table 3. Relations

Name	Target label(s)	Cardinality	Description
CONTAINS	:Asciidoc:Block	0..n	References contained Asciidoc blocks.

Asciidoc Common Properties

Properties common to many Asciidoc nodes.

Table 4. Properties

Name	Description
context	The Asciidoctor AST property
role	The Asciidoctor AST property
style	The Asciidoctor AST property
reftext	The Asciidoctor AST property

:Asciidoc:Block

Properties and relations common to all Asciidoc blocks are described here. Blocks can be specialized as described below or also be standalone nodes.

Has also Asciidoc Common Properties.

Table 5. Properties

Name	Description
titel	The Asciidoctor AST property
level	The Asciidoctor AST property

Table 6. Relations

Name	Target label(s)	Cardinality	Description
CONTAINS	:Asciidoc:Block	0..n	References contained Asciidoc blocks.

:Asciidoc:Block:Section

Represents an Asciidoc section.

Is a :Asciidoc:Block.

Table 7. Properties

Name	Description
index	The Asciidoctor AST property
number	The Asciidoctor AST property
numbered	The Asciidoctor AST property
sectname	The Asciidoctor AST property
special	The Asciidoctor AST property

Table 8. Relations

Name	Target label(s)	Cardinality	Description
HAS_ATTRIBUTE	:Asciidoc:Attribute	0..n	References the attributes of this section.

:Asciidoc:Block:List

Represents an Asciidoc list.

Is a :Asciidoc:Block.

Table 9. Properties

Name	Description
isItem	The Asciidoctor AST property

Table 10. Relations

Name	Target label(s)	Cardinality	Description
HAS_ITEM	:Asciidoc:Block	0..n	References the blocks contained in this list.
HAS_ATTRIBUTE	:Asciidoc:Attribute	0..n	References the attributes of this list.

:Asciidoc:Block:ListItem

Represents an Asciidoc list item.

Is a :Asciidoc:Block.

Table 11. Properties

Name	Description
marker	The Asciidoctor AST property
text	The Asciidoctor AST property
hasTtext	The Asciidoctor AST property

:Asciidoc:Block:Table

Represents an Asciidoc table.

Is a :Asciidoc:Block.

Table 12. Properties

Name	Description
frame	The Asciidoctor AST property
grid	The Asciidoctor AST property

Table 13. Relations

Name	Target label(s)	Cardinality	Description
HAS_COLUMN	:Asciidoc:Column	0..n	References the table columns.
HAS_HEADER_ROW	:Asciidoc:Row	0..n	References the tables header rows.
HAS_ROW	:Asciidoc:Row	0..n	References the tables body rows.
HAS_FOOTER_ROW	:Asciidoc:Row	0..n	References the tables footer rows.
HAS_ATTRIBUTE	:Asciidoc:Attribute	0..n	References the attributes of this table.

:Asciidoc:Column

Represents an Asciidoc table column.

Has also Asciidoc Common Properties.

Table 14. Properties

Name	Description
colnumber	The column number of this cell (no AST property).

:Asciidoc:Row

Represents an Asciidoc table row.

Table 15. Properties

Name	Description
rownumber	The row number of this row.

Table 16. Relations

Name	Target label(s)	Cardinality	Description
CONTAINS_CELL	:Asciidoc:Cell	0..n	References the cells of this row.

:Asciidoc:Cell

Represents an Asciidoc table row cell.

Has also Asciidoc Common Properties.

Table 17. Properties

Name	Description
colnumber	The column number of this cell (no AST property).
style	The Asciidoctor AST property
text	The Asciidoctor AST property

Table 18. Relations

Name	Target label(s)	Cardinality	Description
OF_COLUMN	:Asciidoc:Column	n..1	References the column of this cell.

:Asciidoc:Attribute

Represents an Asciidoc attribute.

Table 19. Properties

Name	Description
name	The attribute name.
value	The attribute value.