Tim Cas | 31 Jan 2012 00:46
Picon
Gravatar

Customizing Synopsis output

Hey there, I'm working on getting the output of Synopsis customized for my game engine: 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
- the file tree doesn't work (I cannot open any subdirectories)
- 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)
- name index is missing functions (I can only see structs and defines there)
- everything is in globals.html (instead of per-file stuff, say foo/bar.h.html for items located in in foo/bar.h)
- Texlive output is broken on my end...?

I'll also have to find out how to get manpage output up and running, plus (I suppose) LaTeX/PDF.

So er... Any ideas as to how to resolve these issues? =\

_______________________________________________
Synopsis-devel mailing list
Synopsis-devel <at> lists.fresco.org
http://lists.fresco.org/cgi-bin/listinfo/synopsis-devel
Stefan Seefeld | 9 Feb 2012 17:04

Re: Customizing Synopsis output

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...
Tim Cas | 9 Feb 2012 17:17
Picon
Gravatar

Re: Customizing Synopsis output

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 <stefan <at> seefeld.name> 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...

_______________________________________________
Synopsis-devel mailing list
Synopsis-devel <at> lists.fresco.org
http://lists.fresco.org/cgi-bin/listinfo/synopsis-devel
Tim Cas | 9 Feb 2012 17:34
Picon
Gravatar

Re: Customizing Synopsis output

Okay, now...

You can find the scripts here:
https://github.com/SIEGE/siege/tree/master/doc
(synopsis.py and synopsis.sh)

FileListing is the one that doesn't work:
http://codepad.org/3U49m0TI

As for the file tree, here are the generated HTML docs:
http://docs.libsiege.org/html/

The tree on the top-left doesn't work.

On 9 February 2012 17:17, Tim Cas <darkuranium <at> gmail.com> wrote:
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 <stefan <at> seefeld.name> 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...


_______________________________________________
Synopsis-devel mailing list
Synopsis-devel <at> lists.fresco.org
http://lists.fresco.org/cgi-bin/listinfo/synopsis-devel
Tim Cas | 9 Feb 2012 17:36
Picon
Gravatar

Re: Customizing Synopsis output

Oh and, regarding the NameIndex issue - see the NameIndex tab in the main frame in the HTML docs, you'll notice functions and some other stuff are missing.

On 9 February 2012 17:34, Tim Cas <darkuranium <at> gmail.com> wrote:
Okay, now...

You can find the scripts here:
https://github.com/SIEGE/siege/tree/master/doc
(synopsis.py and synopsis.sh)

FileListing is the one that doesn't work:
http://codepad.org/3U49m0TI

As for the file tree, here are the generated HTML docs:
http://docs.libsiege.org/html/

The tree on the top-left doesn't work.


On 9 February 2012 17:17, Tim Cas <darkuranium <at> gmail.com> wrote:
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 <stefan <at> seefeld.name> 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...



_______________________________________________
Synopsis-devel mailing list
Synopsis-devel <at> lists.fresco.org
http://lists.fresco.org/cgi-bin/listinfo/synopsis-devel

Gmane