summaryrefslogtreecommitdiff
path: root/docs/modules/extensions/pages/postprocessor.adoc
diff options
context:
space:
mode:
authorSarah White <graphitefriction@gmail.com>2020-12-18 16:56:51 -0700
committerGitHub <noreply@github.com>2020-12-18 16:56:51 -0700
commitfffa2ed16cd1be9f7f6bb7356e1eda83d47fc972 (patch)
tree0dda9ef8df40bbe8087b66bfadaee5cf948d1571 /docs/modules/extensions/pages/postprocessor.adoc
parent47c5bf28ee16f598bff7f31901437c3a193ee685 (diff)
parent717a1cbd6b7c9af192325b76d96ae5e86aeeb595 (diff)
merge PR #3880
resolves #3861 import Asciidoctor docs from asciidoctor.org/docs
Diffstat (limited to 'docs/modules/extensions/pages/postprocessor.adoc')
-rw-r--r--docs/modules/extensions/pages/postprocessor.adoc35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/modules/extensions/pages/postprocessor.adoc b/docs/modules/extensions/pages/postprocessor.adoc
new file mode 100644
index 00000000..130ca547
--- /dev/null
+++ b/docs/modules/extensions/pages/postprocessor.adoc
@@ -0,0 +1,35 @@
+= Postprocessor Extension Example
+:navtitle: Postprocessor
+
+Purpose::
+Insert copyright text in the footer.
+
+== CopyrightFooterPostprocessor
+
+[source,ruby]
+----
+class CopyrightFooterPostprocessor < Asciidoctor::Extensions::Postprocessor
+ def process document, output
+ content = (document.attr 'copyright') || 'Copyright Acme, Inc.'
+ if document.basebackend? 'html'
+ replacement = %(<div id="footer-text">\\1<br>\n#{content}\n</div>)
+ output = output.sub(/<div id="footer-text">(.*?)<\/div>/m, replacement)
+ elsif document.basebackend? 'docbook'
+ replacement = %(<simpara>#{content}</simpara>\n\\1)
+ output = output.sub(/(<\/(?:article|book)>)/, replacement)
+ end
+ output
+ end
+end
+----
+
+== Usage
+
+[source,ruby]
+----
+Asciidoctor::Extensions.register do
+ postprocessor CopyrightFooterPostprocessor
+end
+
+Asciidoctor.convert_file 'sample-with-copyright-footer.adoc', safe: :safe
+----