Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-devel / 2007-11

fpdoc TOC link in HTML output

7 messages · 4 people · –

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Graeme Geldenhuys

Hi,

I have the same annoyance with my generated docs for fpGUI, but I'll the FPC html docs as an example.

The Free Pascal TOC page is
http://www.freepascal.org/docs-html/index.html

The FCL docs are
http://www.freepascal.org/docs-html/fcl/index.html

The RTL docs are
http://www.freepascal.org/docs-html/rtl/index.html

Once you view the RTL or the FCL docs, there is no link back to the TOC page! You can got to the beginning of the Package (top right link on each page), but never to the TOC page and most generated docs that use Packages have a TOC page.

I propose we address this issue.
1) A quick work-around would be to parse all the generated html and manually insert the link. LUFDoc (help for the PSP or Powtils web utilities) do this this and is amazingly quick, but it's a bit of a hack.

2) Or we could add some parameter to fpdoc telling it the title (or maybe it's always TOC) and the location of the toc page (normally this would be '../index.html').

What's your thoughts on this? Any better suggestions?

Regards,
- Graeme -

_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/

Reply by email

Vincent Snijders
to Graeme Geldenhuys
Graeme Geldenhuys wrote 31 lines
Hi, I have the same annoyance with my generated docs for fpGUI, but I'll the FPC html docs as an example. The Free Pascal TOC page is http://www.freepascal.org/docs-html/index.html The FCL docs are http://www.freepascal.org/docs-html/fcl/index.html The RTL docs are http://www.freepascal.org/docs-html/rtl/index.html Once you view the RTL or the FCL docs, there is no link back to the TOC page! You can got to the beginning of the Package (top right link on each page), but never to the TOC page and most generated docs that use Packages have a TOC page. I propose we address this issue. 1) A quick work-around would be to parse all the generated html and manually insert the link. LUFDoc (help for the PSP or Powtils web utilities) do this this and is amazingly quick, but it's a bit of a hack. 2) Or we could add some parameter to fpdoc telling it the title (or maybe it's always TOC) and the location of the toc page (normally this would be '../index.html'). What's your thoughts on this? Any better suggestions?

A suggestion (not better): If you don't want to hack, you can pass the footer parameter.

fpdoc --footer=some_footer_snippet_containing_xhtmlfragment.xml

Vincent

Reply by email

Graeme Geldenhuys
to Vincent Snijders
Vincent Snijders wrote
A suggestion (not better): If you don't want to hack, you can pass the footer parameter. fpdoc --footer=some_footer_snippet_containing_xhtmlfragment.xml

Ah, that could work as a quick fix, but the down side would be that the navigation would be on a totally different location to the other navigation (top menu) links.

Regards,
- Graeme -

_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/

Reply by email

Vincent Snijders
to Graeme Geldenhuys
Graeme Geldenhuys wrote 9 lines
On 09/11/2007, Vincent Snijders wrote: > A suggestion (not better): If you don't want to hack, you can pass the footer parameter. > > fpdoc --footer=some_footer_snippet_containing_xhtmlfragment.xml Ah, that could work as a quick fix, but the down side would be that the navigation would be on a totally different location to the other navigation (top menu) links.

Yes, it is not a better suggestion.

Vincent

Reply by email

Michael Van Canneyt
to Graeme Geldenhuys: I have the same annoyance with my generated docs for fpGUI, but I'll the FPC html docs as…
Graeme Geldenhuys wrote 31 lines
Hi, I have the same annoyance with my generated docs for fpGUI, but I'll the FPC html docs as an example. The Free Pascal TOC page is http://www.freepascal.org/docs-html/index.html The FCL docs are http://www.freepascal.org/docs-html/fcl/index.html The RTL docs are http://www.freepascal.org/docs-html/rtl/index.html Once you view the RTL or the FCL docs, there is no link back to the TOC page! You can got to the beginning of the Package (top right link on each page), but never to the TOC page and most generated docs that use Packages have a TOC page. I propose we address this issue. 1) A quick work-around would be to parse all the generated html and manually insert the link. LUFDoc (help for the PSP or Powtils web utilities) do this this and is amazingly quick, but it's a bit of a hack. 2) Or we could add some parameter to fpdoc telling it the title (or maybe it's always TOC) and the location of the toc page (normally this would be '../index.html'). What's your thoughts on this? Any better suggestions?

You can use the 'search' link mechanism for this, or the suggestion of Vincent.

In general, I think we should add a --header option or --headerfile option which will be used to insert a text before or after the link to the package (the [#rtl])

This is a small addition, I'll see about implementing it.

Michael.

Reply by email

Graeme Geldenhuys
to Michael Van Canneyt
Michael Van Canneyt wrote 6 lines
In general, I think we should add a --header option or --headerfile option which will be used to insert a text before or after the link to the package (the [#rtl]) This is a small addition, I'll see about implementing it.

That would be much appreciated!!

Regards,
- Graeme -

_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/

Reply by email

L
to Graeme Geldenhuys: I have the same annoyance with my generated docs for fpGUI, but I'll the FPC html docs as…
Show quoted text 5 lines
1) A quick work-around would be to parse all the generated html and manually insert the link. LUFDoc (help for the PSP or Powtils web utilities) do this this and is amazingly quick, but it's a bit of a hack.

Actually I have engineered it modular like this:

fileout(header);
fileout(navbar);
fileout(fpdoc);
fileout(notes);
fileout(usercomments);
fileout(footer);

You can edit the navbar separate from the other parts of the system. Kind of like how with SCMS you can edit the navbar on the left hand side with your own links.

The hack is that I use fasthtmlparser to convert static html links into cgi?style=links. This could be implemented into fpdoc instead of fasthtmlparser being used... I just wanted to run fasthtmlparser over thousands of files as a stress test. It acted as a real world unit test case for fasthtmlparser.

L505

Reply by email