Date: Mon, 20 Feb 2023 14:23:25 +0100 From: Moin Rahman <bofh@freebsd.org> To: Chris Watson <bsdunix44@gmail.com> Cc: freebsd-doc@freebsd.org Subject: Re: Plantuml support in asciidoctor, some uml formats work, others not so much... Message-ID: <B4F69800-C6AD-4A8B-B105-C91313D9A2C3@freebsd.org> In-Reply-To: <6AC7F257-455A-49CC-85D2-E5F2329AD0DA@freebsd.org> References: <CAHnbxSRkM7v%2Br=3W-ETHRaH=0ssRbuTfR2sLxNbLv3ueA4xoNw@mail.gmail.com> <6AC7F257-455A-49CC-85D2-E5F2329AD0DA@freebsd.org>
index | next in thread | previous in thread | raw e-mail
[-- Attachment #1 --]
> On Feb 20, 2023, at 1:15 PM, Moin Rahman <bofh@freebsd.org> wrote:
>
>
>
>> On Feb 20, 2023, at 6:35 AM, Chris Watson <bsdunix44@gmail.com <mailto:bsdunix44@gmail.com>> wrote:
>>
>> I felt this was the best list to ask about this, if it's not punt me in the right direction.
>> I have a 13.1-RELEASE-p7 jail with all the 'latest' rubygem-asciidoctor-* pkg's installed.
>> I was just starting to experiment with asciidoctor-diagram and I have noticed that some of plantumls formats work, and some do not. Here are two simple examples using this command line "asciidoctor -b html5 -o index.html -r asciidoctor-diagram example.adoc -w":
>>
>> plantuml that works:
>>
>> [plantuml, format=svg]
>> ....
>> @startuml <>
>> User -> (start)
>> User --> (Use the application) : Label
>> @enduml <>
>> ....
>>
>> <>
>> plantuml that does not work:
>>
>> [plantuml, format=svg]
>> ....
>> @startuml
>> object London
>>
>> map CapitalCity {
>> UK *-> London
>> USA => Washington
>> Germany => Berlin
>> }
>> @enduml
>> ....
>>
>> The latter gives a syntax error. It's lifted directly from the plantuml wesbite examples so I'm not sure that error is correct? And I know that @startuml and @enduml *should* be optional in an asciidoc document when using asciidoctor-diagram. But it fails even without them.
>>
>> The error is:
>>
>> [From string (line 4)]
>> @startuml <>
>> object London
>>
>> map CapitalCity {
>> Syntax error?
>>
>> Both work correctly in plantuml.com <http://plantuml.com/>'s demo server window that lets you enter uml to render. This also happens when using other formats like yaml or mindmap which is part of plantuml and asciidoctor-diagram is supposed to support as well. It seems hit or miss on what formats asciidoctor-diagram is able to render from the main plantuml.com <http://plantuml.com/>; page. Is this an issue of asciidoctor-diagram? is it behind in supporting these formats? is it our port? Can anyone more well versed in the asciidoctor realm explain what's going on here?
>>
>> Thank you very much!
>>
>> Chris
>
> We have a very old version of rubygem-asciidoctor-diagram. I am working on upgrading it. Additionally for plantuml you will also require java installed.
>
> Kind regards,
> Moin(bofh@ with docs@ hat on)
I have updated rubygem-asciidoctor to a later version 2.0.0 which is also old but as we are planning to use this in our documentation project I am just not taking the big risk of jumping into latest. However please check and revert.
Kind regards,
Moin
[-- Attachment #2 --]
<html><head><meta http-equiv="Content-Type" content="text/html; charset=us-ascii"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; line-break: after-white-space;" class=""><br class=""><div><br class=""><blockquote type="cite" class=""><div class="">On Feb 20, 2023, at 1:15 PM, Moin Rahman <<a href="mailto:bofh@freebsd.org" class="">bofh@freebsd.org</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><meta http-equiv="Content-Type" content="text/html; charset=us-ascii" class=""><div style="word-wrap: break-word; -webkit-nbsp-mode: space; line-break: after-white-space;" class=""><br class=""><div class=""><br class=""><blockquote type="cite" class=""><div class="">On Feb 20, 2023, at 6:35 AM, Chris Watson <<a href="mailto:bsdunix44@gmail.com" class="">bsdunix44@gmail.com</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><div dir="ltr" class=""><div dir="ltr" class="">I felt this was the best list to ask about this, if it's not punt me in the right direction.<div class="">I have a 13.1-RELEASE-p7 jail with all the 'latest' rubygem-asciidoctor-* pkg's installed.</div><div class="">I was just starting to experiment with asciidoctor-diagram and I have noticed that some of plantumls formats work, and some do not. Here are two simple examples using this command line "asciidoctor -b html5 -o index.html -r asciidoctor-diagram example.adoc -w": </div>
<div class=""><br class=""></div><div class="">plantuml that works:</div><div class=""><br class=""></div><div class="">[plantuml, format=svg]</div><div class="">....</div><div class=""><a class="gmail_plusreply" id="m_8497397790948741279plusReplyChip-0">@startuml</a><br class=""></div><div class="">User -> (start)</div><div class="">User --> (Use the application) : Label</div><div class=""><a class="gmail_plusreply" id="m_8497397790948741279plusReplyChip-1">@enduml</a><br class="">....<br class=""><a class="gmail_plusreply"><br class=""></a></div><div class="">plantuml that does not work:</div><div class=""><br class=""></div><div class="">[plantuml, format=svg]</div><div class="">....</div><div class="">@startuml<br class="">object London<br class=""><br class="">map CapitalCity {<br class=""> UK *-> London<br class=""> USA => Washington<br class=""> Germany => Berlin<br class="">}<br class="">@enduml<br class=""></div><div class="">....</div><div class=""><br class=""></div><div class="">The latter gives a syntax error. It's lifted directly from the plantuml wesbite examples so I'm not sure that error is correct? And I know that @startuml and @enduml *should* be optional in an asciidoc document when using asciidoctor-diagram. But it fails even without them.</div><div class=""><br class=""></div><div class="">The error is:</div><div class=""><br class=""></div><div class="">[From string (line 4)]</div><div class=""><a class="gmail_plusreply" id="m_8497397790948741279plusReplyChip-4">@startuml</a><br class=""></div><div class="">object London</div><div class=""><br class=""></div><div class="">map CapitalCity {</div><div class="">Syntax error?</div><div class=""><br class=""></div><div class="">Both work correctly in <a href="http://plantuml.com/" target="_blank" class="">plantuml.com</a>'s demo server window that lets you enter uml to render. This also happens when using other formats like yaml or mindmap which is part of plantuml and asciidoctor-diagram is supposed to support as well. It seems hit or miss on what formats asciidoctor-diagram is able to render from the main <a href="http://plantuml.com/" target="_blank" class="">plantuml.com</a> page. Is this an issue of asciidoctor-diagram? is it behind in supporting these formats? is it our port? Can anyone more well versed in the asciidoctor realm explain what's going on here?</div><div class=""><br class=""></div><div class="">Thank you very much!</div><div class=""><br class=""></div><div class="">Chris</div></div></div>
</div></blockquote></div><br class=""><div class="">We have a very old version of rubygem-asciidoctor-diagram. I am working on upgrading it. Additionally for plantuml you will also require java installed.</div><div class=""><br class=""></div><div class="">Kind regards,</div><div class="">Moin(bofh@ with docs@ hat on)</div></div></div></blockquote></div><br class=""><div class="">I have updated rubygem-asciidoctor to a later version 2.0.0 which is also old but as we are planning to use this in our documentation project I am just not taking the big risk of jumping into latest. However please check and revert.</div><div class=""><br class=""></div><div class="">Kind regards,</div><div class="">Moin</div></body></html>
home |
help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?B4F69800-C6AD-4A8B-B105-C91313D9A2C3>