References and automatic numbering for figures and tables

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

References and automatic numbering for figures and tables

Gavin Radolan
Hello,

I'm using Doxygen to create a reference manual. Input is markdown. Output is LaTeX and html. Currently using Doxygen 1.8.8.

I'm wondering if there are any plans for Doxygen to support automatic numbering of figures and tables, with referencing capability from the markdown text?

For example, behavior similar to the @section command's LaTeX output. But separate enumeration for figures and another separate enumeration for tables. And with the enumeration showing up in both LaTeX and html output.

Syntax might be something like this,

At the figure:

           ![fig_name](images/fig_growth_vs_time.png   "Growth rate vs time")

or maybe

          ![](images/fig_growth_vs_time.png   "Growth rate vs time")
          @figure fig_name "Growth rate vs time"

The first example is preferable for it's simplicity, but maybe it's difficult to have ![Caption text ] used for multiple purposes...

At the table:

@table tab_name Growth rate data 2009 - 2014

| Year | Growth Rate|
|:------:|-----------------:|
| 2009|         0.3245  |
....whatever....
    
In the body text:

The growth rate for the last five years is shown in \ref tab_name. As can be seen in /ref fig_name, the growth rate is logarithmic.

In the generated pdf/html:

The growth rate for the last five years is shown in Table 93: Growth rate 2009 - 2014. As can be seen in Figure 125: Growth rate vs time, the growth rate is logarithmic.

So "Figure N" and "Table M" are automatically generated and pre-pended to the caption for each figure/table in the document. And you can link to any figure or table anyplace in the doc using a /ref tag. 

I've noticed some users implement similar functionality with post-processing scripts or other "add-on" tools, such as doxynum. I could do likewise, but first, wanted to ask whether or not there are plans to have such functionality "built-in" to Doxygen - and if so, approximately when?

Kind regards,

Gavin Radolan



------------------------------------------------------------------------------
One dashboard for servers and applications across Physical-Virtual-Cloud
Widest out-of-the-box monitoring support with 50+ applications
Performance metrics, stats and reports that give you Actionable Insights
Deep dive visibility with transaction tracing using APM Insight.
http://ad.doubleclick.net/ddm/clk/290420510;117567292;y
_______________________________________________
Doxygen-develop mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
Reply | Threaded
Open this post in threaded view
|

Re: References and automatic numbering for figures and tables

Bastiaan Veelo
+1 for generated labels to figures and tables.

Just wanted to chime in, in support of this feature request. We do our 400 page manual [1] in Doxygen, and referencing to figures is the one thing that we still miss.

All our figures are in \figure syntax, so I’d hope an implementation would support that as well.

I’d suggest using the stem of the figure file name as the label name. That way, the syntax for images can stay the same. So, in the below example, \ref fig_growth_vs_time would generate a link to the figure (top of the figure, not the caption at the bottom).

Tables in HTML format could probably be labeled using the <A name=“,,,”> named anchor, for LaTeX output as well.

Best regards,
Bastiaan Veelo.



On 28 Apr 2015, at 01:26, Gavin Radolan <[hidden email]> wrote:

Hello,

I'm using Doxygen to create a reference manual. Input is markdown. Output is LaTeX and html. Currently using Doxygen 1.8.8.

I'm wondering if there are any plans for Doxygen to support automatic numbering of figures and tables, with referencing capability from the markdown text?

For example, behavior similar to the @section command's LaTeX output. But separate enumeration for figures and another separate enumeration for tables. And with the enumeration showing up in both LaTeX and html output.

Syntax might be something like this,

At the figure:

           ![fig_name](images/fig_growth_vs_time.png   "Growth rate vs time")

or maybe

          ![](images/fig_growth_vs_time.png   "Growth rate vs time")
          @figure fig_name "Growth rate vs time"

The first example is preferable for it's simplicity, but maybe it's difficult to have ![Caption text ] used for multiple purposes...

At the table:

@table tab_name Growth rate data 2009 - 2014

| Year | Growth Rate|
|:------:|-----------------:|
| 2009|         0.3245  |
....whatever....
    
In the body text:

The growth rate for the last five years is shown in \ref tab_name. As can be seen in /ref fig_name, the growth rate is logarithmic.

In the generated pdf/html:

The growth rate for the last five years is shown in Table 93: Growth rate 2009 - 2014. As can be seen in Figure 125: Growth rate vs time, the growth rate is logarithmic.

So "Figure N" and "Table M" are automatically generated and pre-pended to the caption for each figure/table in the document. And you can link to any figure or table anyplace in the doc using a /ref tag. 

I've noticed some users implement similar functionality with post-processing scripts or other "add-on" tools, such as doxynum. I could do likewise, but first, wanted to ask whether or not there are plans to have such functionality "built-in" to Doxygen - and if so, approximately when?

Kind regards,

Gavin Radolan


------------------------------------------------------------------------------
One dashboard for servers and applications across Physical-Virtual-Cloud
Widest out-of-the-box monitoring support with 50+ applications
Performance metrics, stats and reports that give you Actionable Insights
Deep dive visibility with transaction tracing using APM Insight.
http://ad.doubleclick.net/ddm/clk/290420510;117567292;y_______________________________________________
Doxygen-develop mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-develop


------------------------------------------------------------------------------
One dashboard for servers and applications across Physical-Virtual-Cloud
Widest out-of-the-box monitoring support with 50+ applications
Performance metrics, stats and reports that give you Actionable Insights
Deep dive visibility with transaction tracing using APM Insight.
http://ad.doubleclick.net/ddm/clk/290420510;117567292;y
_______________________________________________
Doxygen-develop mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-develop