diff options
Diffstat (limited to 'paper/lua-filters/plantuml')
| -rw-r--r-- | paper/lua-filters/plantuml/Makefile | 3 | ||||
| -rw-r--r-- | paper/lua-filters/plantuml/output.html | 45 | ||||
| -rw-r--r-- | paper/lua-filters/plantuml/plantuml.lua | 56 | ||||
| -rw-r--r-- | paper/lua-filters/plantuml/readme.md | 30 |
4 files changed, 0 insertions, 134 deletions
diff --git a/paper/lua-filters/plantuml/Makefile b/paper/lua-filters/plantuml/Makefile deleted file mode 100644 index feff6f4..0000000 --- a/paper/lua-filters/plantuml/Makefile +++ /dev/null @@ -1,3 +0,0 @@ -test: - @pandoc --self-contained --lua-filter=plantuml.lua --metadata title=README readme.md -o output.html - diff --git a/paper/lua-filters/plantuml/output.html b/paper/lua-filters/plantuml/output.html deleted file mode 100644 index 67c4b58..0000000 --- a/paper/lua-filters/plantuml/output.html +++ /dev/null @@ -1,45 +0,0 @@ -<!DOCTYPE html> -<html xmlns="http://www.w3.org/1999/xhtml" lang xml:lang> -<head> - <meta charset="utf-8" /> - <meta name="generator" content="pandoc" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> - <title>readme</title> - <style type="text/css"> - code{white-space: pre-wrap;} - span.smallcaps{font-variant: small-caps;} - span.underline{text-decoration: underline;} - div.column{display: inline-block; vertical-align: top; width: 50%;} - </style> - <!--[if lt IE 9]> - <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> - <![endif]--> -</head> -<body> -<h1 id="plantuml-pandoc-filter">PlantUML Pandoc filter</h1> -<p>PlantUML Pandoc filter to process code blocks with class “plantuml” containing PlantUML notation into images.</p> -<ul> -<li>For textual output formats, use –extract-media=DIR</li> -<li>For HTML formats, you may alternatively use –self-contained</li> -</ul> -<h2 id="example-in-markdown-file">Example in markdown-file</h2> -<p><img src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiBjb250ZW50U2NyaXB0VHlwZT0iYXBwbGljYXRpb24vZWNtYXNjcmlwdCIgY29udGVudFN0eWxlVHlwZT0idGV4dC9jc3MiIGhlaWdodD0iMTYxcHgiIHByZXNlcnZlQXNwZWN0UmF0aW89Im5vbmUiIHN0eWxlPSJ3aWR0aDo1NDRweDtoZWlnaHQ6MTYxcHg7IiB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCA1NDQgMTYxIiB3aWR0aD0iNTQ0cHgiIHpvb21BbmRQYW49Im1hZ25pZnkiPjxkZWZzPjxmaWx0ZXIgaGVpZ2h0PSIzMDAlIiBpZD0iZnE3c29pNjk5dWp3ayIgd2lkdGg9IjMwMCUiIHg9Ii0xIiB5PSItMSI+PGZlR2F1c3NpYW5CbHVyIHJlc3VsdD0iYmx1ck91dCIgc3RkRGV2aWF0aW9uPSIyLjAiLz48ZmVDb2xvck1hdHJpeCBpbj0iYmx1ck91dCIgcmVzdWx0PSJibHVyT3V0MiIgdHlwZT0ibWF0cml4IiB2YWx1ZXM9IjAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIC40IDAiLz48ZmVPZmZzZXQgZHg9IjQuMCIgZHk9IjQuMCIgaW49ImJsdXJPdXQyIiByZXN1bHQ9ImJsdXJPdXQzIi8+PGZlQmxlbmQgaW49IlNvdXJjZUdyYXBoaWMiIGluMj0iYmx1ck91dDMiIG1vZGU9Im5vcm1hbCIvPjwvZmlsdGVyPjwvZGVmcz48Zz48bGluZSBzdHlsZT0ic3Ryb2tlOiAjQTgwMDM2OyBzdHJva2Utd2lkdGg6IDEuMDsgc3Ryb2tlLWRhc2hhcnJheTogNS4wLDUuMDsiIHgxPSIzMiIgeDI9IjMyIiB5MT0iMzkuNjA5NCIgeTI9IjEyMC4zMTI1Ii8+PGxpbmUgc3R5bGU9InN0cm9rZTogI0E4MDAzNjsgc3Ryb2tlLXdpZHRoOiAxLjA7IHN0cm9rZS1kYXNoYXJyYXk6IDUuMCw1LjA7IiB4MT0iNTE1LjUiIHgyPSI1MTUuNSIgeTE9IjM5LjYwOTQiIHkyPSIxMjAuMzEyNSIvPjxyZWN0IGZpbGw9IiNGRUZFQ0UiIGZpbHRlcj0idXJsKCNmcTdzb2k2OTl1andrKSIgaGVpZ2h0PSIzMS42MDk0IiBzdHlsZT0ic3Ryb2tlOiAjQTgwMDM2OyBzdHJva2Utd2lkdGg6IDEuNTsiIHdpZHRoPSI0NCIgeD0iOCIgeT0iMyIvPjx0ZXh0IGZpbGw9IiMwMDAwMDAiIGZvbnQtZmFtaWx5PSJzYW5zLXNlcmlmIiBmb250LXNpemU9IjE0IiBsZW5ndGhBZGp1c3Q9InNwYWNpbmdBbmRHbHlwaHMiIHRleHRMZW5ndGg9IjMwIiB4PSIxNSIgeT0iMjQuNTMzMiI+QWxpY2U8L3RleHQ+PHJlY3QgZmlsbD0iI0ZFRkVDRSIgZmlsdGVyPSJ1cmwoI2ZxN3NvaTY5OXVqd2spIiBoZWlnaHQ9IjMxLjYwOTQiIHN0eWxlPSJzdHJva2U6ICNBODAwMzY7IHN0cm9rZS13aWR0aDogMS41OyIgd2lkdGg9IjQ0IiB4PSI4IiB5PSIxMTkuMzEyNSIvPjx0ZXh0IGZpbGw9IiMwMDAwMDAiIGZvbnQtZmFtaWx5PSJzYW5zLXNlcmlmIiBmb250LXNpemU9IjE0IiBsZW5ndGhBZGp1c3Q9InNwYWNpbmdBbmRHbHlwaHMiIHRleHRMZW5ndGg9IjMwIiB4PSIxNSIgeT0iMTQwLjg0NTciPkFsaWNlPC90ZXh0PjxyZWN0IGZpbGw9IiNGRUZFQ0UiIGZpbHRlcj0idXJsKCNmcTdzb2k2OTl1andrKSIgaGVpZ2h0PSIzMS42MDk0IiBzdHlsZT0ic3Ryb2tlOiAjQTgwMDM2OyBzdHJva2Utd2lkdGg6IDEuNTsiIHdpZHRoPSIzOSIgeD0iNDk0LjUiIHk9IjMiLz48dGV4dCBmaWxsPSIjMDAwMDAwIiBmb250LWZhbWlseT0ic2Fucy1zZXJpZiIgZm9udC1zaXplPSIxNCIgbGVuZ3RoQWRqdXN0PSJzcGFjaW5nQW5kR2x5cGhzIiB0ZXh0TGVuZ3RoPSIyNSIgeD0iNTAxLjUiIHk9IjI0LjUzMzIiPkJvYjwvdGV4dD48cmVjdCBmaWxsPSIjRkVGRUNFIiBmaWx0ZXI9InVybCgjZnE3c29pNjk5dWp3aykiIGhlaWdodD0iMzEuNjA5NCIgc3R5bGU9InN0cm9rZTogI0E4MDAzNjsgc3Ryb2tlLXdpZHRoOiAxLjU7IiB3aWR0aD0iMzkiIHg9IjQ5NC41IiB5PSIxMTkuMzEyNSIvPjx0ZXh0IGZpbGw9IiMwMDAwMDAiIGZvbnQtZmFtaWx5PSJzYW5zLXNlcmlmIiBmb250LXNpemU9IjE0IiBsZW5ndGhBZGp1c3Q9InNwYWNpbmdBbmRHbHlwaHMiIHRleHRMZW5ndGg9IjI1IiB4PSI1MDEuNSIgeT0iMTQwLjg0NTciPkJvYjwvdGV4dD48cG9seWdvbiBmaWxsPSIjQTgwMDM2IiBwb2ludHM9IjUwNCw2Ny45NjA5LDUxNCw3MS45NjA5LDUwNCw3NS45NjA5LDUwOCw3MS45NjA5IiBzdHlsZT0ic3Ryb2tlOiAjQTgwMDM2OyBzdHJva2Utd2lkdGg6IDEuMDsiLz48bGluZSBzdHlsZT0ic3Ryb2tlOiAjQTgwMDM2OyBzdHJva2Utd2lkdGg6IDEuMDsiIHgxPSIzMiIgeDI9IjUxMCIgeTE9IjcxLjk2MDkiIHkyPSI3MS45NjA5Ii8+PHRleHQgZmlsbD0iIzAwMDAwMCIgZm9udC1mYW1pbHk9InNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iMTMiIGxlbmd0aEFkanVzdD0ic3BhY2luZ0FuZEdseXBocyIgdGV4dExlbmd0aD0iMzY4IiB4PSIzOSIgeT0iNjcuMTA0NSI+QXV0aGVudGljYXRpb24gUmVxdWVzdCBCb2IgLS0mZ3Q7IEFsaWNlOiBBdXRoZW50aWNhdGlvbiBSZXNwb25zZTwvdGV4dD48cG9seWdvbiBmaWxsPSIjQTgwMDM2IiBwb2ludHM9IjUwNCw5OC4zMTI1LDUxNCwxMDIuMzEyNSw1MDQsMTA2LjMxMjUsNTA4LDEwMi4zMTI1IiBzdHlsZT0ic3Ryb2tlOiAjQTgwMDM2OyBzdHJva2Utd2lkdGg6IDEuMDsiLz48bGluZSBzdHlsZT0ic3Ryb2tlOiAjQTgwMDM2OyBzdHJva2Utd2lkdGg6IDEuMDsiIHgxPSIzMiIgeDI9IjUxMCIgeTE9IjEwMi4zMTI1IiB5Mj0iMTAyLjMxMjUiLz48dGV4dCBmaWxsPSIjMDAwMDAwIiBmb250LWZhbWlseT0ic2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMyIgbGVuZ3RoQWRqdXN0PSJzcGFjaW5nQW5kR2x5cGhzIiB0ZXh0TGVuZ3RoPSI0NjAiIHg9IjM5IiB5PSI5Ny40NTYxIj5Bbm90aGVyIGF1dGhlbnRpY2F0aW9uIFJlcXVlc3QgQWxpY2UgJmx0Oy0tIEJvYjogYW5vdGhlciBhdXRoZW50aWNhdGlvbiBSZXNwb25zZTwvdGV4dD48IS0tCkBzdGFydHVtbA0KQWxpY2UgLT4gQm9iOiBBdXRoZW50aWNhdGlvbiBSZXF1ZXN0IEJvYiAtIC0+IEFsaWNlOiBBdXRoZW50aWNhdGlvbiBSZXNwb25zZQ0KQWxpY2UgLT4gQm9iOiBBbm90aGVyIGF1dGhlbnRpY2F0aW9uIFJlcXVlc3QgQWxpY2UgPC0gLSBCb2I6IGFub3RoZXIgYXV0aGVudGljYXRpb24gUmVzcG9uc2UNCkBlbmR1bWwNCgpQbGFudFVNTCB2ZXJzaW9uIDEuMjAxOC4wOChTdW4gSnVuIDI0IDE0OjMxOjAwIENFU1QgMjAxOCkKKEdQTCBzb3VyY2UgZGlzdHJpYnV0aW9uKQpKYXZhIFJ1bnRpbWU6IEphdmEoVE0pIFNFIFJ1bnRpbWUgRW52aXJvbm1lbnQKSlZNOiBKYXZhIEhvdFNwb3QoVE0pIDY0LUJpdCBTZXJ2ZXIgVk0KSmF2YSBWZXJzaW9uOiAxLjguMF8xNzItYjExCk9wZXJhdGluZyBTeXN0ZW06IFdpbmRvd3MgMTAKT1MgVmVyc2lvbjogMTAuMApEZWZhdWx0IEVuY29kaW5nOiBDcDEyNTIKTGFuZ3VhZ2U6IGRlCkNvdW50cnk6IERFCi0tPjwvZz48L3N2Zz4=" alt="PlantUML Diagramm" /></p> -<h2 id="run-pandoc">Run pandoc</h2> -<pre><code>pandoc --self-contained --lua-filter=plantuml.lua readme.md -o output.htm</code></pre> -<h2 id="prerequisites">Prerequisites</h2> -<ul> -<li>download PlantUML from http://plantuml.com (needs JAVA)</li> -<li>3 ways to set the environment -<ol type="1"> -<li>plantuml.lua and plantuml.jar in the same folder and start pandoc always from this folder</li> -<li>set a Environment Variable PLANTUML with the path to plantuml.jar -<ul> -<li>Windows - with powershell: Set-Item env:PLANTUML “c:.jar”</li> -</ul></li> -<li>change path to plantuml.jar in plantuml.lua</li> -</ol></li> -</ul> -<p>This script based on the example “Converting ABC code to music notation” from https://pandoc.org/lua-filters.html</p> -<p>This script was only tested with markdown to html on a windows environment!</p> -</body> -</html> diff --git a/paper/lua-filters/plantuml/plantuml.lua b/paper/lua-filters/plantuml/plantuml.lua deleted file mode 100644 index 7903e6a..0000000 --- a/paper/lua-filters/plantuml/plantuml.lua +++ /dev/null @@ -1,56 +0,0 @@ ---[[ -# PlantUML Pandoc filter -PlantUML Pandoc filter to process code blocks with class "plantuml" containing PlantUML notation into images. - -* For textual output formats, use --extract-media=DIR -* For HTML formats, you may alternatively use --self-contained - -## Example in markdown-file -```plantuml -@startuml -Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response -Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response @enduml -``` -## Run pandoc -``` -pandoc --self-contained --lua-filter=plantuml.lua readme.md -o output.htm -``` - -## Prerequisites -* download PlantUML from http://plantuml.com (needs JAVA) -* 3 ways to set the environment - 1. plantuml.lua and plantuml.jar in the same folder and start pandoc always from this folder - 2. set a Environment Variable PLANTUML with the path to plantuml.jar - * Windows - with powershell: Set-Item env:PLANTUML "c:\bin\plantuml.jar" - 3. change path to plantuml.jar in plantuml.lua - -This script based on the example "Converting ABC code to music notation" from https://pandoc.org/lua-filters.html -**This script was only tested with markdown to html on a windows environment!** -]] - --- Path to PlantUML.jar --- if you use opinion 3 change the path to plantuml.jar like this: --- local plantumlPath = os.getenv("PLANTUML") or "c:\\bin\\plantuml.jar" -local plantumlPath = os.getenv("PLANTUML") or "plantuml.jar" - --- SVG has a much better quality --- local filetype = "png" --- local mimetype = "image/png" -local filetype = "svg" -local mimetype = "image/svg+xml" - --- call plantuml.jar wit some parameters (see plantuml help) -local function plantuml(puml, filetype, plantumlPath) - local final = pandoc.pipe("java", {"-jar", plantumlPath, "-t" .. filetype, "-pipe", "-charset", "UTF8"}, puml) - return final -end - --- search for class "plantuml" and replace with image -function CodeBlock(block) - if block.classes[1] == "plantuml" then - local img = plantuml(block.text, filetype, plantumlPath) - local fname = pandoc.sha1(img) .. "." .. filetype - pandoc.mediabag.insert(fname, mimetype, img) - return pandoc.Para{ pandoc.Image({pandoc.Str("PlantUML Diagramm")}, fname) } - end -end diff --git a/paper/lua-filters/plantuml/readme.md b/paper/lua-filters/plantuml/readme.md deleted file mode 100644 index de5ba74..0000000 --- a/paper/lua-filters/plantuml/readme.md +++ /dev/null @@ -1,30 +0,0 @@ -# PlantUML Pandoc filter -PlantUML Pandoc filter to process code blocks with class "plantuml" containing PlantUML notation into images. - -* For textual output formats, use --extract-media=DIR -* For HTML formats, you may alternatively use --self-contained - -## Example in markdown-file -```plantuml -@startuml -Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response -Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response -@enduml -``` -## Run pandoc -``` -pandoc --self-contained --lua-filter=plantuml.lua readme.md -o output.htm -``` - -## Prerequisites -* download PlantUML from http://plantuml.com (needs JAVA) -* 3 ways to set the environment - 1. plantuml.lua and plantuml.jar in the same folder and start pandoc always from this folder - 2. set a Environment Variable PLANTUML with the path to plantuml.jar - * Windows - with powershell: Set-Item env:PLANTUML "c:\bin\plantuml.jar" - 3. change path to plantuml.jar in plantuml.lua - - -This script based on the example "Converting ABC code to music notation" from https://pandoc.org/lua-filters.html - -This script was only tested with markdown to html on a windows environment! |