gmane.text.doxygen.general

Creating a < at >subpage connection without actuallygenerating a link

Lefteris Karapetsas — 2012-05-23T03:05:25

Hello all,

I have a question to the group, related
 to my previous question but this time regarding only < at >subpage. I have 
the same setup I presented in my previous email but I also want the 
included htmls which come from generated pages to be a subpage to this 
main doc page. < at >subpage would work nicely except I don't want the link 
to appear the way all other links appear in the documentation nor do I 
want it to appear where I write the < at >subpage command. Is there any 
option to create the < at >subpage link between two pages but without 
actually having the link appear? What I am using now is a hidden div to 
achieve it. Any other more doxygen-ish way exists?

Here is what I do:

/**
**
** <div style="display:none;">
** < at >subpage ExampleTopic1PGE
** < at >subpage ExampleTopic2PGE
** </div>

**<!-- more stuff above -->

** < at >docsubsection{3.1 ExampleTopic_1}
** < at >docsubpage{ExampleTopic1PGE}

** < at >htmlinclude Doxygen_Html/ExampleTopic1PGE.html

**

** < at >docsubsection{3.2 Example Topic 2}
** < at >docsubpage{ExampleTopic2PGE

Re: Tableofcontents and copydocing a page

Lefteris Karapetsas — 2012-05-23T01:04:09

Hello again,

Basically I made hacked-up a solution that works for now and since I don't see any other alternative I suppose this is what will stay unless someone has any other way to suggest how to achieve this:

/**
**<!-- more stuff above -->
** < at >docsubsection{3.1 ExampleTopic_1}
** < at >htmlinclude Doxygen_Html/ExampleTopic1PGE.html
**
** < at >docsubsection{3.2 Example Topic 2}
** < at >htmlinclude Doxygen_Html/ExampleTopic2PGE.html
** <!-- more stuff below -->
**/

Here consider docsusbsection as basically an < at >subsection command but with just different style from all the other < at >subsection.
Then I include an html file which is located inside a special folder of the Example directory.
  Here is where the hack gets complicated. This html is basically the < at >page I wanted to link to, stripped down only to
its <div class="contents"> part and generated by a python script I made. So in effect I have to run doxygen twice for this to work. 
1) First time will generate the documentation and all the relevant < at >page but this < at >htm

Re: Markup For Tables - No Header Row

Dimitri Van Heesch — 2012-05-22T19:40:40

On May 22, 2012, at 21:22 , Jake Colman wrote:


It is not supported at the moment. 

In the future I may add support for restructured-text style tables:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#tables
which do support tables without header.

Regards,
  Dimitri


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

Re: Opening new tab for svg image through "arrowout"

Jake Colman — 2012-05-22T19:24:01

   DVH> Hi Jake,
   >>>>
   >>>> I am getting a different error:
   >>>>
   >>>> The requested URL
   >>>> /builds/mu/PAS_6_8/SRC/lib/doc/classpqLineEdit__inherit__graph_org.svg
   >>>> was not found on this server.
   >>>>
   >>>> It looks like Doxygen is not generating the original SVG file at all!
   >>>>
   >>>> Any ideas?
   >>
   DVH> If you run doxygen incrementally, you need to manually remove
   DVH> the .svg files one time to trigger the generation of the
   DVH> _org.svg files.
   >>
   >> My build procedure blows away the entire docs subdirectory prior to
   >> generating the documentation so its definitely not being done
   >> incrementally.  I regenerated a second time and I still have the same
   >> problem.

   DVH> Can you check if the file is generated at all? I can imagine it
   DVH> is not accessible from a web server if the path starts with
   DVH> /build/..., but that this does mean it is not generated.

   DVH> If it really is not generated then please provide a
   DVH> self-contained

Re: Markup For Tables - No Header Row

Jake Colman — 2012-05-22T19:22:56

   SP> Am 22.05.2012 14:44, schrieb Jake Colman:
   >> 
   >> I'd like to use the Markup technique for creating a table but I
   >> need a table without a header (my table is several rows/columns of
   >> values and the header would meaningless).  Looking at the commands
   >> it looks like it insists on treating the first row in a special
   >> way.  Is there a way around this?
   >> 

   SP> Which syntax do you use?

   SP> This should be easy with HTML tables, don't know with Markdown.

I know how to do it with HTML tables but it's a pain to
read/write/maintain.  Markdown syntax is much easier.  But I don't see
how to do away with the table header.

Re: Opening new tab for svg image through "arrowout"

Dimitri Van Heesch — 2012-05-22T19:07:10

Hi Jake,


Can you check if the file is generated at all? I can imagine it is not accessible
from a web server if the path starts with /build/..., but that this does mean it is
not generated.

If it really is not generated then please provide a self-contained example (source+config
file in a tar or zip) that allows me to reproduce the problem.

Regards,
  Dimitri



------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

Re: Markup For Tables - No Header Row

Stefan Pendl — 2012-05-22T15:39:26

Am 22.05.2012 14:44, schrieb Jake Colman:

Which syntax do you use?

This should be easy with HTML tables, don't know with Markdown.


--
Stefan P.

Top-posting:
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
A: Top-posting.
Q: What is the most annoying thing in e-mail?

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

Markup For Tables - No Header Row

Jake Colman — 2012-05-22T12:44:02

I'd like to use the Markup technique for creating a table but I need a
table without a header (my table is several rows/columns of values and
the header would meaningless).  Looking at the commands it looks like it
insists on treating the first row in a special way.  Is there a way
around this?

Re: Tableofcontents and copydocing a page

André Glória — 2012-05-22T10:53:29

Hi Lefteris,

unfortunately, I'm not that "savy" regarding html and I haven't had the 
time to tune my html documentation.
So, at this time, I do not know of a similar solution to html...


Regards,
André

On 05/21/2012 11:14 AM, Lefteris Karapetsas wrote:
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/_______________________________________________
Doxygen-users mailing list
Doxygen-users< at >lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Help Linking to External Documentation

Jake Colman — 2012-05-21T22:06:43

   DVH> On May 21, 2012, at 14:09 , Jake Colman wrote:
   >>>>>>>> "DVH" == Dimitri Van Heesch <doxygen< at >gmail.com> writes:
   >>>
   DVH> Hi Jake,
   DVH> On May 17, 2012, at 14:15 , Jake Colman wrote:
   >>>>>
   >>>>> I am trying to figure out how to use Tag Files to link to
   >>>>> external documentation that is available for the third party
   >>>>> libraries that I am using, specifically Qt and Roguewave
   >>>>> SourcePro.  For both libraries I have access to their source
   >>>>> code.  Both libraries also provide beautiful documentation on
   >>>>> their respective web sites.  In Roguwave's case I'm almost
   >>>>> certain it was produced by some version of Doxygen.
   >>>>>
   >>>>> What is the recommended way to include Roguwave's and Qt's
   >>>>> documentation in to my own documentation so that I process
   >>>>> Roguwave and Qt only once?  Do I have to first run Doxygen
   >>>>> against the third-party source code?  Doxygen's manual seems to
   >>>>> imply that you can link to external documen

Re: Help Linking to External Documentation

Jake Colman — 2012-05-21T21:51:54

   DVH> On May 21, 2012, at 14:09 , Jake Colman wrote:
   >>>>>>> "DVH" == Dimitri Van Heesch <doxygen< at >gmail.com> writes:
   >>
   DVH> Hi Jake,
   DVH> On May 17, 2012, at 14:15 , Jake Colman wrote:
   >>>>
   >>>> I am trying to figure out how to use Tag Files to link to
   >>>> external documentation that is available for the third party
   >>>> libraries that I am using, specifically Qt and Roguewave
   >>>> SourcePro.  For both libraries I have access to their source
   >>>> code.  Both libraries also provide beautiful documentation on
   >>>> their respective web sites.  In Roguwave's case I'm almost
   >>>> certain it was produced by some version of Doxygen.
   >>>>
   >>>> What is the recommended way to include Roguwave's and Qt's
   >>>> documentation in to my own documentation so that I process
   >>>> Roguwave and Qt only once?  Do I have to first run Doxygen
   >>>> against the third-party source code?  Doxygen's manual seems to
   >>>> imply that you can link to external documentation even if y

Re: Opening new tab for svg image through "arrowout"

Jake Colman — 2012-05-21T21:40:14

   DVH> On May 21, 2012, at 16:15 , Jake Colman wrote:
   >>>>>>> "A" == Albert  <albert.tests< at >gmail.com> writes:
   >> 
   A> Dear All,
   A> In the new release there has been a change in respect to handling svg
   A> images:
   >>>> + CHG: For interactive SVGs the print button has been replaced by a
   >>>> "arrow out" button that opens the original non-interactive SVG in a
   >>>> new window.
   >> 
   A> When I click on Windows, using the latest version of Firefox, on the
   A> arrow a new, empty tab is opened, and I get the message:
   >> 
   A> Firefox doesn't know how to open this address, as the protocol(d)
   A> isn't associated with any program.
   >> 
   A> When doing the same in the Internet Explorer a new tab is opened and
   A> the svg image is shown.
   >> 
   A> (When doing the same in the older version (printer icon) I got similar
   A> messages, but I never used it.)
   >> 
   A> Any suggestions ?
   >> 
   A> Albert
   >> 
   >> I am getting a different error:
   >> 
   >> The requested U

Re: < at >subpage not working properly,if a page and a section of another page have the same name

Dimitri Van Heesch — 2012-05-21T17:29:41

On May 21, 2012, at 16:23 , Stefan Ludewig wrote:


Yes they need to be unique, so you need to define a naming convention. 
Simply prefixing the page label before each section label would do the trick, i.e. < at >section FooBar_Bar.

Regards,
  Dimitri


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

Re: Help Linking to External Documentation

Dimitri Van Heesch — 2012-05-21T17:26:54

On May 21, 2012, at 14:09 , Jake Colman wrote:


It should preferably be the same as they have used, but you can disable all outputs
(GENERATE_HTML, GENERATE_LATEX, GENERATE_RTF, GENERATE_MAN, GENERATE_XML)

For the Qt sources you need to run qdoc3 in order to get the right tag file.

Regards,
  Dimitri



------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

Re: Opening new tab for svg image through "arrowout"

Dimitri Van Heesch — 2012-05-21T17:23:51

On May 21, 2012, at 16:15 , Jake Colman wrote:


If you run doxygen incrementally, you need to manually remove the .svg files
one time to trigger the generation of the _org.svg files.

Regards,
  Dimitri



------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

< at >subpage not working properly, if a page and a section of another page have the same name

Stefan Ludewig — 2012-05-21T14:23:59

Hi all.



I have a setup like this:



/**

< at >mainpage Name

< at >subpage Foo

< at >subpage FooBar

*/



/**

< at >page Foo Foo

Some text

< at >subpage Bar

*/



/**

< at >page Bar Bar

Some text

*/



/**

< at >page FooBar

Some text

< at >section Bar

Some more text

*/



If I generate a doxygen html-docs from this setup, then the subpage link on
page Foo links to FooBar’s section Bar instead of to page Bar. However, the
link in the treeview correctly links to page Bar.



Is this a known bug with known workarounds od do I really have to assure,
that all pages, sections, subsections and subsubsections in a project have
unique names (which could be quite problematic when generating a doc from
multiple projects from different devs)?



Thanks,

Stefan.
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint secur

Re: Opening new tab for svg image through "arrowout"

Jake Colman — 2012-05-21T14:15:41

   A> Dear All,
   A> In the new release there has been a change in respect to handling svg images:
   >> + CHG: For interactive SVGs the print button has been replaced by a
   >> "arrow out" button that opens the original non-interactive SVG in a
   >> new window.

   A> When I click on Windows, using the latest version of Firefox, on the
   A> arrow a new, empty tab is opened, and I get the message:

   A>   Firefox doesn't know how to open this address, as the protocol(d)
   A> isn't associated with any program.

   A> When doing the same in the Internet Explorer a new tab is opened and
   A> the svg image is shown.

   A> (When doing the same in the older version (printer icon) I got similar
   A> messages, but I never used it.)

   A> Any suggestions ?

   A> Albert

I am getting a different error:

The requested URL
/builds/mu/PAS_6_8/SRC/lib/doc/classpqLineEdit__inherit__graph_org.svg
was not found on this server.

It looks like Doxygen is not generating the original SVG file at all!

Any ideas?

...

Re: Help Linking to External Documentation

Jake Colman — 2012-05-21T12:09:37

   DVH> Hi Jake,
   DVH> On May 17, 2012, at 14:15 , Jake Colman wrote:
   >> 
   >> I am trying to figure out how to use Tag Files to link to external
   >> documentation that is available for the third party libraries that
   >> I am using, specifically Qt and Roguewave SourcePro.  For both
   >> libraries I have access to their source code.  Both libraries also
   >> provide beautiful documentation on their respective web sites.  In
   >> Roguwave's case I'm almost certain it was produced by some version
   >> of Doxygen.
   >> 
   >> What is the recommended way to include Roguwave's and Qt's
   >> documentation in to my own documentation so that I process
   >> Roguwave and Qt only once?  Do I have to first run Doxygen against
   >> the third-party source code?  Doxygen's manual seems to imply that
   >> you can link to external documentation even if you do not have the
   >> original source code?  Also, if I have to process the source code,
   >> what is the value of the URL option to the tag file?

Re: Tableofcontents and copydocing a page

Lefteris Karapetsas — 2012-05-21T10:14:38


Hello Andre,

Thanks for the reply. I am actually using html for my documentation. Is there any similar solution like the one you propose for the html documentation?

Thanks,
  -Lefteris
Date: Mon, 21 May 2012 10:11:58 +0100
From: andre.gloria< at >bithium.com
To: doxygen-users< at >lists.sourceforge.net
Subject: Re: [Doxygen-users] Tableofcontents and copydocing a page


  
    
  
  
    Hello Lefteris,

    

    I'm assuming you are creating a latex (PDF) output with doxygen so:

    

    Answer 1: In the latex header file that Doxygen will use you can add
    a \setcounter{tocdepth}{3} line to change to which level
    should the toc go to.

                     Check here
    in the table the meaning of the levels.

    

    Answer 2: As far as I know doxygen's include commands are all kinda
    related to source code only. So my solution is to use latex
    commands, in the place where you want to include the other file

                    you can use \latexonly \include{path to file to
      include} \end

Re: Tableofcontents and copydocing a page

André Glória — 2012-05-21T09:11:58

Hello Lefteris,

I'm assuming you are creating a latex (PDF) output with doxygen so:

Answer 1: In the latex header file that Doxygen will use you can add a 
/\setcounter{tocdepth}{3}/ line to change to which level should the toc 
go to.
                  Check here 
<https://en.wikibooks.org/wiki/LaTeX/Document_Structure#Sectioning_Commands> 
in the table the meaning of the levels.

Answer 2: As far as I know doxygen's include commands are all kinda 
related to source code only. So my solution is to use latex commands, in 
the place where you want to include the other file
                 you can use /\latexonly \include{path to file to 
include} \endlatexonly/ that I believe should work.

Regards,
André

On 05/20/2012 05:23 PM, Lefteris Karapetsas wrote:
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions

gmane.text.doxygen.general

More documentation on \example?

Creating a < at >subpage connection without actuallygenerating a link

Re: Tableofcontents and copydocing a page

Re: Markup For Tables - No Header Row

Re: Opening new tab for svg image through "arrowout"

Re: Markup For Tables - No Header Row

Re: Opening new tab for svg image through "arrowout"

Re: Markup For Tables - No Header Row

Markup For Tables - No Header Row

Re: Tableofcontents and copydocing a page

Re: Help Linking to External Documentation

Re: Help Linking to External Documentation

Re: Opening new tab for svg image through "arrowout"

Re: < at >subpage not working properly,if a page and a section of another page have the same name

Re: Help Linking to External Documentation

Re: Opening new tab for svg image through "arrowout"

< at >subpage not working properly, if a page and a section of another page have the same name

Re: Opening new tab for svg image through "arrowout"

Re: Help Linking to External Documentation

Re: Tableofcontents and copydocing a page

Re: Tableofcontents and copydocing a page