* [PATCH v2] org-contrib/babel/languages/ob-doc-plantuml.org: ASCII output
@ 2022-08-14 5:34 Joseph Turner
2022-08-14 7:04 ` Ihor Radchenko
0 siblings, 1 reply; 2+ messages in thread
From: Joseph Turner @ 2022-08-14 5:34 UTC (permalink / raw)
To: emacs-orgmode; +Cc: yantar92, Joseph Turner
Document the new functionality of ob-plantuml to insert ASCII diagrams
directly in the buffer.
---
.../babel/languages/ob-doc-plantuml.org | 57 +++++++++++++++----
1 file changed, 46 insertions(+), 11 deletions(-)
diff --git a/org-contrib/babel/languages/ob-doc-plantuml.org b/org-contrib/babel/languages/ob-doc-plantuml.org
index ec347de4..4ae3ca31 100644
--- a/org-contrib/babel/languages/ob-doc-plantuml.org
+++ b/org-contrib/babel/languages/ob-doc-plantuml.org
@@ -49,18 +49,23 @@ Diagram images can be generated in PNG, SVG, and LaTeX formats.
=PlantUML= is integrated with [[https://plantuml.com/running][a wide variety of software applications]].
Babel is a [[https://plantuml.com/emacs][standard way to use PlantUML in Emacs]].
* Requirements and Setup
-=PlantUML= requires a working [[https://www.java.com/en/download/][Java]] installation and access to the
-=plantuml.jar= component. A working [[https://graphviz.org/][GraphViz]] installation is required
-for many diagrams.
+=PlantUML= blocks can be executed in one of two ways, requiring either
+
+- a working [[https://www.java.com/en/download/][Java]] installation and access to the =plantuml.jar= component or
+- the =plantuml= executable available from your distribution's package manager
+
+A working [[https://graphviz.org/][GraphViz]] installation is required for many diagrams.
Emacs has [[https://github.com/skuro/plantuml-mode][plantuml-mode]], a major mode for editing PlantUML sources.
There are detailed [[https://github.com/skuro/plantuml-mode#installation][installation instructions]], as well as instructions
-for [[https://github.com/skuro/plantuml-mode#integration-with-org-mode][integration with Org]].
+for [[https://github.com/skuro/plantuml-mode#integration-with-org-mode][integration with Org]]. While [[https://melpa.org/#/plantuml-mode][plantuml-mode]] does allow use of a
+remote server to render the diagram, please note that =ob-plantuml= does
+not currently support this functionality.
You will likely want to set the variables =plantuml-jar-path= and
=org-plantuml-jar-path= with the path to your local installation of
-=PlantUML=. Alternatively, set the variable
-=plantuml-default-exec-mode= to access =PlantUML= non-locally.
+=PlantUML=. Alternatively, set the variable =plantuml-default-exec-mode=
+to =executable= to use your local =plantuml= executable.
Activate evaluation of =PlantUML= source code blocks by adding
=plantuml= to =org-babel-load-languages=.
@@ -77,15 +82,22 @@ Activate evaluation of =PlantUML= source code blocks by adding
** Header Arguments
=PlantUML= code blocks default to =:results file= and =:exports results=.
-=PlantUML= has these language-specific header arguments and one requirement:
- - file :: =PlantUML= code blocks require that an output file be specified
+If you wish to export the =PlantUML= code block to a file, you must
+specify a =:file= header argument. Alternatively, if you set =:results=
+to a value other than =file=, such as =:results verbatim=, then the ASCII
+=PlantUML= output will be inserted into the buffer below the code block.
+
+=PlantUML= has these language-specific header arguments:
- cmdline :: specify [[https://plantuml.com/command-line][command line arguments]] for =PlantUML=
- java :: arguments for the =java= runtimes (JRE)
** Sessions
=PlantUML= does not support sessions.
** Result Types
-A =PlantUML= code block returns a link to the file it generates.
-
+When the =:file= header argument has been specified, =PlantUML= code
+blocks return a link to the generated file. Alternatively, if
+=:results= is set to a value other than =file=, then the generated ASCII
+diagram will be inserted into the buffer.
+
* Examples of Use
:PROPERTIES:
:header-args:plantuml: :eval no-export
@@ -119,7 +131,7 @@ b -> c
,#+end_src
#+end_example
-HTML output of the =PlantUML= code block:
+PNG output of the =PlantUML= code block:
#+begin_src plantuml :file images/theme-uml.png :exports both
!theme spacelab
a -> b
@@ -130,3 +142,26 @@ b -> c
#+RESULTS:
[[file:images/theme-uml.png]]
+Here is an example of ASCII output inserted directly into the buffer.
+
+The =PlantUML= code block in the Org buffer:
+#+begin_example
+,#+begin_src plantuml :results verbatim
+Bob -> Alice : Hello World!
+,#+end_src
+#+end_example
+
+ASCII output of the =PlantUML= code block:
+#+begin_src plantuml :results verbatim
+Bob -> Alice : Hello World!
+#+end_src
+
+#+RESULTS:
+: ,---. ,-----.
+: |Bob| |Alice|
+: `-+-' `--+--'
+: | Hello World! |
+: |-------------->|
+: ,-+-. ,--+--.
+: |Bob| |Alice|
+: `---' `-----'
--
2.37.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH v2] org-contrib/babel/languages/ob-doc-plantuml.org: ASCII output
2022-08-14 5:34 [PATCH v2] org-contrib/babel/languages/ob-doc-plantuml.org: ASCII output Joseph Turner
@ 2022-08-14 7:04 ` Ihor Radchenko
0 siblings, 0 replies; 2+ messages in thread
From: Ihor Radchenko @ 2022-08-14 7:04 UTC (permalink / raw)
To: Joseph Turner; +Cc: emacs-orgmode
Joseph Turner <joseph@breatheoutbreathe.in> writes:
> Document the new functionality of ob-plantuml to insert ASCII diagrams
> directly in the buffer.
> ---
> .../babel/languages/ob-doc-plantuml.org | 57 +++++++++++++++----
> 1 file changed, 46 insertions(+), 11 deletions(-)
Thanks!
Applied onto master via e68a7903.
https://git.sr.ht/~bzg/worg/commit/e68a7903a2a85b0deaa8f54d63524045441aeb8d
--
Ihor Radchenko,
Org mode contributor,
Learn more about Org mode at https://orgmode.org/.
Support Org development at https://liberapay.com/org-mode,
or support my work at https://liberapay.com/yantar92
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2022-08-14 7:05 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-08-14 5:34 [PATCH v2] org-contrib/babel/languages/ob-doc-plantuml.org: ASCII output Joseph Turner
2022-08-14 7:04 ` Ihor Radchenko
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).