diff options
| author | Shahbaz Youssefi <ShabbyX@gmail.com> | 2023-04-02 03:15:37 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-02 01:15:37 -0600 |
| commit | ed8a5dc529bbadbc6894b65b35d14df1a275a5ef (patch) | |
| tree | 23ebb13b8a07737612281da89cfad1250d88b9b9 /docs/modules/extensions/pages/tree-processor.adoc | |
| parent | e151958d2e9b7a3b6d47ddd9ed45f78bf8911e7b (diff) | |
document Preprocessor and TreeProcessor more thoroughly (PR #4415)
Diffstat (limited to 'docs/modules/extensions/pages/tree-processor.adoc')
| -rw-r--r-- | docs/modules/extensions/pages/tree-processor.adoc | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/docs/modules/extensions/pages/tree-processor.adoc b/docs/modules/extensions/pages/tree-processor.adoc index ef598100..c27788db 100644 --- a/docs/modules/extensions/pages/tree-processor.adoc +++ b/docs/modules/extensions/pages/tree-processor.adoc @@ -1,10 +1,20 @@ -= Tree Processor Extension Example += Tree Processor Extensions :navtitle: Tree Processor +TreeProcessors are run on the Document after the source has been parsed into an abstract syntax tree (AST), as represented by the Document object and its child Node objects (e.g., Section, Block, List, ListItem). + +Asciidoctor invokes the `Processor#process` method on an instance of each registered TreeProcessor. + +The AST nodes contain unconverted text (for example `[.role]#hello#`), and conversion is typically done when the text is read from the node (for the previous example, returning `<span class="role">hello</span>`). Unconverted text can be written back to the node during transformation (for example `[.role]#goodbye#`). + +TreeProcessor implementations must extend https://www.rubydoc.info/gems/asciidoctor/Asciidoctor/Extensions/TreeProcessor[`TreeProcessor`]. + +== Tree Processor Extension Example + Purpose:: Detect literal blocks that contain shell commands, strip the prompt character and style the command using CSS in such a way that the prompt character cannot be selected (as seen on help.github.com). -== sample-with-shell-session.adoc +=== sample-with-shell-session.adoc [source,asciidoc] ---- @@ -14,7 +24,7 @@ Detect literal blocks that contain shell commands, strip the prompt character an $ gem install asciidoctor ---- -== ShellSessionTreeProcessor +=== ShellSessionTreeProcessor [source,ruby] ---- @@ -47,7 +57,7 @@ class ShellSessionTreeProcessor < Asciidoctor::Extensions::TreeProcessor end ---- -== Usage +=== Usage [source,ruby] ---- |