Re: Collapsible Code Fragments

Jacopo Pantaleoni <[email protected]> Tue, 8 Jan 2019 12:05:38 +0100
Newsgroups gmane.text.doxygen.devel
Message-ID <CALyofL3Gt+NXCJ=OBstfPgUa+3PS=vvD=K60LCb3hFaMAuqruA@mail.gmail.com>
--===============7119684052305229585==
Content-Type: multipart/alternative; boundary="0000000000000145e7057ef054c8"

--0000000000000145e7057ef054c8
Content-Type: text/plain; charset="UTF-8"

Many thanks Albert for the quick answer!

I will post it to the issue tracker then.

I still think it would be a great option to have, especially to write
guides through the code and things like that.
Perhaps it could be an opt-in feature controlled by some config, if you
fear it would make things generally too slow.

Jacopo

On Tue, Jan 8, 2019 at 10:52 AM Albert <[email protected]> wrote:

> Dear Jacopo,
>
> This is indeed a good place to post it, but I think an even better place
> would be in the doxygen issue tracker (
> https://github.com/doxygen/doxygen/issues/new).
> As is it looks to me like a nice idea, but it will add to the complexity
> of the page handling and to the responsiveness.
> Some collapsible parts can already been seen with e.g. inherited functions
> and class diagrams.
>
> Albert
>
> On Tue, Jan 8, 2019 at 10:42 AM Jacopo Pantaleoni <[email protected]>
> wrote:
>
>> Hello Everyone,
>>
>> I never wrote here so I apologize if this is not the right place for
>> feature requests, but...
>> inspired by the output of literate programming you can find in this book:
>>
>>
>> http://www.pbr-book.org/3ed-2018/Shapes/Basic_Shape_Interface.html#Shape
>>
>> I was wondering that the ability to mark some code blocks collapsible
>> (e.g. inside \code / \endcode or even more importantly in \snippet
>> sections) would make for a _great_ feature.
>>
>> In fact, perhaps one could reuse the block markers already present for
>> \snippet to automatically make sub-blocks collapsible?
>>
>> e.g. if I had:
>>
>> //! [MyBlock]
>> int a;
>> //! [Initialize Vars]
>> a = foo() ;
>> //! [Initialize Vars]
>> ...
>> //! [MyBlock]
>>
>> it would be great if the HTML output for a snippet containing MyBlock
>> contained a collapsible section referring to the block "Initialize Vars".
>>
>> What do you think?
>>
>> Best Regards,
>> -Jacopo
>>
>> _______________________________________________
>> Doxygen-develop mailing list
>> [email protected]
>> https://lists.sourceforge.net/lists/listinfo/doxygen-develop
>>
>

--0000000000000145e7057ef054c8
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr">Many thanks Albert for the quick answer!<div><br></div><di=
v>I will post it to the issue tracker then.</div><div><br></div><div>I stil=
l think it would be a great option to have, especially to write guides thro=
ugh the code and things like that.</div><div>Perhaps it could be an opt-in =
feature controlled by some config, if you fear it would make things general=
ly too slow.</div><div><br></div><div>Jacopo</div></div><br><div class=3D"g=
mail_quote"><div dir=3D"ltr">On Tue, Jan 8, 2019 at 10:52 AM Albert &lt;<a =
href=3D"mailto:[email protected]">[email protected]</a>&gt; wrote=
:<br></div><blockquote class=3D"gmail_quote" style=3D"margin:0px 0px 0px 0.=
8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir=3D"lt=
r"><div dir=3D"ltr"><div>Dear Jacopo,</div><div><br></div><div>This is inde=
ed a good place to post it, but I think an even better place would be in th=
e doxygen issue tracker (<a href=3D"https://github.com/doxygen/doxygen/issu=
es/new" target=3D"_blank">https://github.com/doxygen/doxygen/issues/new</a>=
).</div><div>As is it looks to me like a nice idea, but it will add to the =
complexity of the page handling and to the responsiveness.</div><div>Some c=
ollapsible parts can already been seen with e.g. inherited functions and cl=
ass diagrams.<br></div><div><br></div><div>Albert<br></div></div></div><br>=
<div class=3D"gmail_quote"><div dir=3D"ltr">On Tue, Jan 8, 2019 at 10:42 AM=
 Jacopo Pantaleoni &lt;<a href=3D"mailto:[email protected]" target=3D"_=
blank">[email protected]</a>&gt; wrote:<br></div><blockquote class=3D"g=
mail_quote" style=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204=
,204,204);padding-left:1ex"><div dir=3D"ltr"><div dir=3D"ltr"><div dir=3D"l=
tr">Hello Everyone,<div><br></div><div>I never wrote here so I apologize if=
 this is not the right place for feature requests, but...</div><div>inspire=
d by the output of literate programming you can find in this book:</div><di=
v><br></div><div>=C2=A0 <a href=3D"http://www.pbr-book.org/3ed-2018/Shapes/=
Basic_Shape_Interface.html#Shape" target=3D"_blank">http://www.pbr-book.org=
/3ed-2018/Shapes/Basic_Shape_Interface.html#Shape</a>=C2=A0</div><div><br><=
/div><div>I was wondering that the ability to mark some code blocks collaps=
ible (e.g. inside \code / \endcode or even more importantly in \snippet sec=
tions) would make for a _great_ feature.</div><div><br></div><div>In fact, =
perhaps one could reuse the block markers already present for \snippet to a=
utomatically make sub-blocks collapsible?</div><div><br></div><div>e.g. if =
I had:</div><div><br></div><div><div>//! [MyBlock]</div></div><div>int a;</=
div><div>//! [Initialize Vars]<br></div><div><div>a =3D foo() ;</div></div>=
<div>//! [Initialize Vars]</div><div>...=C2=A0=C2=A0<br></div><div><div>//!=
 [MyBlock]=C2=A0</div><div><br></div><div>it would be great if the HTML out=
put for a snippet containing MyBlock contained a collapsible section referr=
ing to the block &quot;Initialize Vars&quot;.=C2=A0</div><div><br></div><di=
v>What do you think?</div><div><br></div><div>Best Regards,</div><div>-Jaco=
po</div><br class=3D"gmail-m_6614115557445750471gmail-m_3109799798990117166=
gmail-Apple-interchange-newline"></div></div></div></div>
_______________________________________________<br>
Doxygen-develop mailing list<br>
<a href=3D"mailto:[email protected]" target=3D"_blank">=
[email protected]</a><br>
<a href=3D"https://lists.sourceforge.net/lists/listinfo/doxygen-develop" re=
l=3D"noreferrer" target=3D"_blank">https://lists.sourceforge.net/lists/list=
info/doxygen-develop</a><br>
</blockquote></div>
</blockquote></div>

--0000000000000145e7057ef054c8--


--===============7119684052305229585==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline


--===============7119684052305229585==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
Doxygen-develop mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-develop

--===============7119684052305229585==--