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>
next in thread | previous in thread | raw e-mail | index | archive | help
--Apple-Mail=_4E09E3FB-20D2-4CD8-9161-D3884F6349CB
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain;
charset=us-ascii
> On Feb 20, 2023, at 1:15 PM, Moin Rahman <bofh@freebsd.org> wrote:
>=20
>=20
>=20
>> On Feb 20, 2023, at 6:35 AM, Chris Watson <bsdunix44@gmail.com =
<mailto:bsdunix44@gmail.com>> wrote:
>>=20
>> 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":=20
>>=20
>> plantuml that works:
>>=20
>> [plantuml, format=3Dsvg]
>> ....
>> @startuml <>
>> User -> (start)
>> User --> (Use the application) : Label
>> @enduml <>
>> ....
>>=20
>> <>
>> plantuml that does not work:
>>=20
>> [plantuml, format=3Dsvg]
>> ....
>> @startuml
>> object London
>>=20
>> map CapitalCity {
>> UK *-> London
>> USA =3D> Washington
>> Germany =3D> Berlin
>> }
>> @enduml
>> ....
>>=20
>> 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.
>>=20
>> The error is:
>>=20
>> [=46rom string (line 4)]
>> @startuml <>
>> object London
>>=20
>> map CapitalCity {
>> Syntax error?
>>=20
>> 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?
>>=20
>> Thank you very much!
>>=20
>> Chris
>=20
> 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.
>=20
> 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=
--Apple-Mail=_4E09E3FB-20D2-4CD8-9161-D3884F6349CB
Content-Transfer-Encoding: quoted-printable
Content-Type: text/html;
charset=us-ascii
<html><head><meta http-equiv=3D"Content-Type" content=3D"text/html; =
charset=3Dus-ascii"></head><body style=3D"word-wrap: break-word; =
-webkit-nbsp-mode: space; line-break: after-white-space;" class=3D""><br =
class=3D""><div><br class=3D""><blockquote type=3D"cite" class=3D""><div =
class=3D"">On Feb 20, 2023, at 1:15 PM, Moin Rahman <<a =
href=3D"mailto:bofh@freebsd.org" class=3D"">bofh@freebsd.org</a>> =
wrote:</div><br class=3D"Apple-interchange-newline"><div class=3D""><meta =
http-equiv=3D"Content-Type" content=3D"text/html; charset=3Dus-ascii" =
class=3D""><div style=3D"word-wrap: break-word; -webkit-nbsp-mode: =
space; line-break: after-white-space;" class=3D""><br class=3D""><div =
class=3D""><br class=3D""><blockquote type=3D"cite" class=3D""><div =
class=3D"">On Feb 20, 2023, at 6:35 AM, Chris Watson <<a =
href=3D"mailto:bsdunix44@gmail.com" class=3D"">bsdunix44@gmail.com</a>>=
wrote:</div><br class=3D"Apple-interchange-newline"><div class=3D""><div =
dir=3D"ltr" class=3D""><div dir=3D"ltr" class=3D"">I felt this was the =
best list to ask about this, if it's not punt me in the right =
direction.<div class=3D"">I have a 13.1-RELEASE-p7 jail with all the =
'latest' rubygem-asciidoctor-* pkg's installed.</div><div class=3D"">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=3D""><br class=3D""></div><div class=3D"">plantuml that =
works:</div><div class=3D""><br class=3D""></div><div =
class=3D"">[plantuml, format=3Dsvg]</div><div class=3D"">....</div><div =
class=3D""><a class=3D"gmail_plusreply" =
id=3D"m_8497397790948741279plusReplyChip-0">@startuml</a><br =
class=3D""></div><div class=3D"">User -> (start)</div><div =
class=3D"">User --> (Use the application) : Label</div><div =
class=3D""><a class=3D"gmail_plusreply" =
id=3D"m_8497397790948741279plusReplyChip-1">@enduml</a><br =
class=3D"">....<br class=3D""><a class=3D"gmail_plusreply"><br =
class=3D""></a></div><div class=3D"">plantuml that does not =
work:</div><div class=3D""><br class=3D""></div><div class=3D"">[plantuml,=
format=3Dsvg]</div><div class=3D"">....</div><div class=3D"">@startuml<br=
class=3D"">object London<br class=3D""><br class=3D"">map CapitalCity =
{<br class=3D""> UK *-> London<br class=3D""> USA =3D> =
Washington<br class=3D""> Germany =3D> Berlin<br class=3D"">}<br =
class=3D"">@enduml<br class=3D""></div><div class=3D"">....</div><div =
class=3D""><br class=3D""></div><div class=3D"">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=3D""><br class=3D""></div><div class=3D"">The error is:</div><div =
class=3D""><br class=3D""></div><div class=3D"">[=46rom string (line =
4)]</div><div class=3D""><a class=3D"gmail_plusreply" =
id=3D"m_8497397790948741279plusReplyChip-4">@startuml</a><br =
class=3D""></div><div class=3D"">object London</div><div class=3D""><br =
class=3D""></div><div class=3D"">map CapitalCity {</div><div =
class=3D"">Syntax error?</div><div class=3D""><br class=3D""></div><div =
class=3D"">Both work correctly in <a href=3D"http://plantuml.com/" =
target=3D"_blank" class=3D"">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=3D"http://plantuml.com/" target=3D"_blank" =
class=3D"">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=3D""><br class=3D""></div><div =
class=3D"">Thank you very much!</div><div class=3D""><br =
class=3D""></div><div class=3D"">Chris</div></div></div>
</div></blockquote></div><br class=3D""><div class=3D"">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=3D""><br class=3D""></div><div class=3D"">Kind =
regards,</div><div class=3D"">Moin(bofh@ with docs@ hat =
on)</div></div></div></blockquote></div><br class=3D""><div class=3D"">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=3D""><br class=3D""></div><div =
class=3D"">Kind regards,</div><div class=3D"">Moin</div></body></html>=
--Apple-Mail=_4E09E3FB-20D2-4CD8-9161-D3884F6349CB--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?B4F69800-C6AD-4A8B-B105-C91313D9A2C3>