Re: Customizing Synopsis output
Tim Cas <[email protected]> Thu, 9 Feb 2012 17:17:38 +0100
| Newsgroups | gmane.comp.documentation.synopsis |
|---|---|
| Message-ID | <CANd9X8f5ySJEUe0uo75SLQ73yeqMykp4HMoCeNo9717ansiDMg@mail.gmail.com> |
--===============0413471692== Content-Type: multipart/alternative; boundary=20cf305640ffd3a0f704b88a590c --20cf305640ffd3a0f704b88a590c Content-Type: text/plain; charset=ISO-8859-1 > > Can you elaborate a little on what you mean by 'as constants' ? Macros > and constants have quite different semantics, so I document them > differently. Are you merely asking to change the heading in HTML output > to not have the word 'Macro' in it ? Or something more involved ? > Yes, that's exactly what I meant - some other word, since I use a lot of those I'd like to separate those from function macros. OK, I have to look into that. Can you provide a specific test case > that's not working ? > Well, just create anything with subdirectories - the little arrows that are supposed to open subdirs in the index do absolutely nothing; and before you ask, yes, Javascript is enabled. Right. Have you tried using a different view ? Perhaps the 'ModuleView' > (which is used by default) makes indeed no sense for C projects (which > don't have any nested scopes). I've tried a ton of others, I can't even remember which ones - some would simply fail to operate (because of a Python exception). Can you please provide a minimal test case showing the behavior ? > I will once I reboot to FreeBSD - but basically, the name index seems to contain only structs and some other things, but no functions. There are different views that display information in different ways. > The "ModuleView" shows information per scope, and thus groups all > "global" symbols in a single view. There are also "FileListing" and > similar views that present per-file symbols (with docs). See above. What format are you using ? There is no direct TeX format in Synopsis. > Sorry, meant Texinfo. You may be interested in the DocBook formatter, from which man pages and > pdf docs can be generated. Hm, I didn't realize that DocBooks can also generate manpages... I'll have to take a look at that. On 9 February 2012 17:04, Stefan Seefeld <[email protected]> wrote: > On 01/30/2012 06:46 PM, Tim Cas wrote: > > Hey there, I'm working on getting the output of Synopsis customized for > > my game engine: http://libsiege.org <http://libsiege.org/> > > > > I've managed to get the pages and index to ignore anything with a '`' > > (anonymous unions/structs) or '_' (private members) prefixes, but I > > still have some problems: > > > > - constants (for which I use #define's) are shown as macros - I'd like > > to show them as constants > > Can you elaborate a little on what you mean by 'as constants' ? Macros > and constants have quite different semantics, so I document them > differently. Are you merely asking to change the heading in HTML output > to not have the word 'Macro' in it ? Or something more involved ? > > > - the file tree doesn't work (I cannot open any subdirectories) > > OK, I have to look into that. Can you provide a specific test case > that's not working ? > > > - I can't find a way to rename "Global Namespace" to something else > > (this is C, not C++, so that name doesn't make much sense) > > Right. Have you tried using a different view ? Perhaps the 'ModuleView' > (which is used by default) makes indeed no sense for C projects (which > don't have any nested scopes). > > > - name index is missing functions (I can only see structs and defines > there) > > Can you please provide a minimal test case showing the behavior ? > > > > - everything is in globals.html (instead of per-file stuff, say > > foo/bar.h.html for items located in in foo/bar.h) > > There are different views that display information in different ways. > The "ModuleView" shows information per scope, and thus groups all > "global" symbols in a single view. There are also "FileListing" and > similar views that present per-file symbols (with docs). > > > - Texlive output is broken on my end...? > > What format are you using ? There is no direct TeX format in Synopsis. > > > I'll also have to find out how to get manpage output up and running, > > plus (I suppose) LaTeX/PDF. > > You may be interested in the DocBook formatter, from which man pages and > pdf docs can be generated. > > Thanks, > Stefan > > -- > > ...ich hab' noch einen Koffer in Berlin... > --20cf305640ffd3a0f704b88a590c Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable <blockquote style=3D"margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204= ,204,204);padding-left:1ex" class=3D"gmail_quote">Can you elaborate a littl= e on what you mean by 'as constants' ? Macros<br> and constants have quite different semantics, so I document them<br> differently. Are you merely asking to change the heading in HTML output<br> to not have the word 'Macro' in it ? Or something more involved ?<b= r></blockquote>Yes, that's exactly what I meant - some other word, sinc= e I use a lot of those I'd like to separate those from function macros.= <br> <br><blockquote style=3D"margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb= (204,204,204);padding-left:1ex" class=3D"gmail_quote">OK, I have to look in= to that. Can you provide a specific test case<br> that's not working ?<br></blockquote><div>Well, just create anything wi= th subdirectories - the little arrows that are supposed to open subdirs in = the index do absolutely nothing; and before you ask, yes, Javascript is ena= bled.<br> <br><blockquote style=3D"margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb= (204,204,204);padding-left:1ex" class=3D"gmail_quote">Right. Have you tried= using a different view ? Perhaps the 'ModuleView'<br> (which is used by default) makes indeed no sense for C projects (which<br> don't have any nested scopes).</blockquote><div>I've tried a ton of= others, I can't even remember which ones - some would simply fail to o= perate (because of a Python exception).<br><br><blockquote style=3D"margin:= 0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex" = class=3D"gmail_quote"> Can you please provide a minimal test case showing the behavior ?<br></bloc= kquote><div>I will once I reboot to FreeBSD - but basically, the name index= seems to contain only structs and some other things, but no functions.<br> <br><blockquote style=3D"margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb= (204,204,204);padding-left:1ex" class=3D"gmail_quote">There are different v= iews that display information in different ways.<br> The "ModuleView" shows information per scope, and thus groups all= <br> "global" symbols in a single view. There are also "FileListi= ng" and<br> similar views that present per-file symbols (with docs).</blockquote><div>S= ee above.<br><br><blockquote style=3D"margin:0pt 0pt 0pt 0.8ex;border-left:= 1px solid rgb(204,204,204);padding-left:1ex" class=3D"gmail_quote">What for= mat are you using ? There is no direct TeX format in Synopsis.<br> </blockquote><div>Sorry, meant Texinfo.<br><br><blockquote style=3D"margin:= 0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex" = class=3D"gmail_quote">You may be interested in the DocBook formatter, from = which man pages and<br> pdf docs can be generated.</blockquote><div>Hm, I didn't realize that D= ocBooks can also generate manpages... I'll have to take a look at that.= <br></div></div></div></div></div></div><br><div class=3D"gmail_quote"> On 9 February 2012 17:04, Stefan Seefeld <span dir=3D"ltr"><<a href=3D"m= ailto:[email protected]">[email protected]</a>></span> wrote:<br><bl= ockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1px #= ccc solid;padding-left:1ex"> <div class=3D"im">On 01/30/2012 06:46 PM, Tim Cas wrote:<br> > Hey there, I'm working on getting the output of Synopsis customize= d for<br> </div>> my game engine: <a href=3D"http://libsiege.org" target=3D"_blank= ">http://libsiege.org</a> <<a href=3D"http://libsiege.org/" target=3D"_b= lank">http://libsiege.org/</a>><br> <div class=3D"im">><br> > I've managed to get the pages and index to ignore anything with a = '`'<br> > (anonymous unions/structs) or '_' (private members) prefixes, = but I<br> > still have some problems:<br> ><br> > - constants (for which I use #define's) are shown as macros - I= 9;d like<br> > to show them as constants<br> <br> </div>Can you elaborate a little on what you mean by 'as constants'= ? Macros<br> and constants have quite different semantics, so I document them<br> differently. Are you merely asking to change the heading in HTML output<br> to not have the word 'Macro' in it ? Or something more involved ?<b= r> <div class=3D"im"><br> > - the file tree doesn't work (I cannot open any subdirectories)<br= > <br> </div>OK, I have to look into that. Can you provide a specific test case<br= > that's not working ?<br> <div class=3D"im"><br> > - I can't find a way to rename "Global Namespace" to som= ething else<br> > (this is C, not C++, so that name doesn't make much sense)<br> <br> </div>Right. Have you tried using a different view ? Perhaps the 'Modul= eView'<br> (which is used by default) makes indeed no sense for C projects (which<br> don't have any nested scopes).<br> <div class=3D"im"><br> > - name index is missing functions (I can only see structs and defines = there)<br> <br> </div>Can you please provide a minimal test case showing the behavior ?<br> <div class=3D"im"><br> <br> > - everything is in globals.html (instead of per-file stuff, say<br> > foo/bar.h.html for items located in in foo/bar.h)<br> <br> </div>There are different views that display information in different ways.= <br> The "ModuleView" shows information per scope, and thus groups all= <br> "global" symbols in a single view. There are also "FileListi= ng" and<br> similar views that present per-file symbols (with docs).<br> <div class=3D"im"><br> > - Texlive output is broken on my end...?<br> <br> </div>What format are you using ? There is no direct TeX format in Synopsis= .<br> <div class=3D"im"><br> > I'll also have to find out how to get manpage output up and runnin= g,<br> > plus (I suppose) LaTeX/PDF.<br> <br> </div>You may be interested in the DocBook formatter, from which man pages = and<br> pdf docs can be generated.<br> <br> Thanks,<br> =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0Stefan<br> <span class=3D"HOEnZb"><font color=3D"#888888"><br> --<br> <br> =A0 =A0 =A0...ich hab' noch einen Koffer in Berlin...<br> </font></span></blockquote></div><br> --20cf305640ffd3a0f704b88a590c-- --===============0413471692== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Synopsis-devel mailing list [email protected] http://lists.fresco.org/cgi-bin/listinfo/synopsis-devel --===============0413471692==--