Thread: Re: [Doxygen-users] import html files?
Brought to you by:
dimitri
Menu
▾
▴
doxygen-users
|
From: Willem B. <w-...@dd...> - 2014-10-01 10:45:55
|
Dear Tom,
I used this to include RFCs in my documentation. To do this, copy the
HTML files somewhere in your project and make sure in can be found (in
my example the ):
in DoxyFile:
EXAMPLE_PATH = web/test \
documentation/htmlincludes/ \
In the source, I create pages:
/// @page soap11 The SOAP specification, version 1.1
/// @htmlinclude SOAP_1_1.html
/// @page soap12 The SOAP specification, version 1.2
/// @htmlinclude SOAP_1_2.html
/// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages
/// @htmlinclude stylesandencodingsinsoap.html
/// @page wsdl11 Web Service Description Language
/// @htmlinclude WSDL_1_1.html
The files referred to in the @htmlinclude commands are in
documentation/htmlincludes/ .
Best regards,
Willem Bogaerts
|
|
From: Tom J. <tom...@gm...> - 2014-10-01 18:21:05
|
Thanks Willem. I appreciate your help. I tried following your instructions,
but I'm getting stuck somewhere and it's not quite working. Here's what I
did:
1. Added folder called htmlincludes on my Desktop.
2. Put some HTML files into this htmlincludes folder.
3. In the Doxygen GUI, on the Expert tab, for the Input topic, for
EXAMPLE_PATH, I added /Users/tjohnson/Desktop/htmlincludes.
4. In a sample helloworld.java, I added some references to @pages in the
source:
/**
* Says hello to the world.
* @author tjohnson
* @category Sample
* @version 1.0
* @page DI ID Rating
* @htmlincludes di_id_rating.html
* @page DI Overview
* @htmlincludes di_overview.html
*
*/
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello world!");
}
}
(Note: I actually wasn't sure where I was supposed to put these references.
I think this might be where I'm going wrong.)
5. Clicked Run to generate Doxygen.
However, no HTML files were included in the Doxygen output.
The only way can seem to get external files included in Doxygen's output is
by putting the files into the source folder. The files have to be in
markdown format with an md extension in order to get included in the output.
I really just want Doxygen to include some HTML files. This seems like a
reasonable task.
Tom
---------------------
801-822-2241
blog: idratherbewriting.com
twitter: tomjohnson
On Wed, Oct 1, 2014 at 3:45 AM, Willem Bogaerts <w-...@dd...> wrote:
> Dear Tom,
>
> I used this to include RFCs in my documentation. To do this, copy the
> HTML files somewhere in your project and make sure in can be found (in
> my example the ):
>
> in DoxyFile:
> EXAMPLE_PATH = web/test \
> documentation/htmlincludes/ \
>
>
> In the source, I create pages:
> /// @page soap11 The SOAP specification, version 1.1
> /// @htmlinclude SOAP_1_1.html
>
> /// @page soap12 The SOAP specification, version 1.2
> /// @htmlinclude SOAP_1_2.html
>
> /// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages
> /// @htmlinclude stylesandencodingsinsoap.html
>
> /// @page wsdl11 Web Service Description Language
> /// @htmlinclude WSDL_1_1.html
>
>
> The files referred to in the @htmlinclude commands are in
> documentation/htmlincludes/ .
>
> Best regards,
> Willem Bogaerts
>
>
>
>
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
>
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
|
|
From: Tom J. <tom...@gm...> - 2014-10-03 19:42:16
|
Any other ideas on how to get doxygen to include standalone html files? I was really hoping to find a solution for merging source-generated doc with other tutorial doc. Tom Sent from my iPhone > On Oct 1, 2014, at 3:45 AM, Willem Bogaerts <w-...@dd...> wrote: > > Dear Tom, > > I used this to include RFCs in my documentation. To do this, copy the > HTML files somewhere in your project and make sure in can be found (in > my example the ): > > in DoxyFile: > EXAMPLE_PATH = web/test \ > documentation/htmlincludes/ \ > > > In the source, I create pages: > /// @page soap11 The SOAP specification, version 1.1 > /// @htmlinclude SOAP_1_1.html > > /// @page soap12 The SOAP specification, version 1.2 > /// @htmlinclude SOAP_1_2.html > > /// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages > /// @htmlinclude stylesandencodingsinsoap.html > > /// @page wsdl11 Web Service Description Language > /// @htmlinclude WSDL_1_1.html > > > The files referred to in the @htmlinclude commands are in > documentation/htmlincludes/ . > > Best regards, > Willem Bogaerts > > > > ------------------------------------------------------------------------------ > Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer > Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports > Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper > Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer > http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|
From: Albert <alb...@gm...> - 2014-10-05 17:37:57
|
I had a similar problem, only that I wanted just a file with a table rows
to be read into a page. I used the following trick:
\htmlonly
<script src="jquery.js"></script>
<script>
$(function(){
$("#includedContent").load("file.html");
});
</script>
<table class="doxtable">
<thead>
<tr>
<th>File</th>
<th>Line</th>
<th>Message</th>
</tr>
</thead>
<tbody id="includedContent">
</tbody>
</table>
\endhtmlonly
One is self responsible for everything and there won't be any links
generated by doxygen when it is generated.
Doxygen is not able to interpret the entire HTML pages, but maybe
translating the HTML to e.g. md and than feeding this to doxygen might give
a possibility. See e.g. pandoc (http://johnmacfarlane.net/pandoc/), I have
no experience with it so I don't know how easy it can be used and what the
quality of the results will be.
Albert
On Fri, Oct 3, 2014 at 9:42 PM, Tom Johnson <tom...@gm...>
wrote:
> Any other ideas on how to get doxygen to include standalone html files? I
> was really hoping to find a solution for merging source-generated doc with
> other tutorial doc.
>
> Tom
>
> Sent from my iPhone
>
> > On Oct 1, 2014, at 3:45 AM, Willem Bogaerts <w-...@dd...> wrote:
> >
> > Dear Tom,
> >
> > I used this to include RFCs in my documentation. To do this, copy the
> > HTML files somewhere in your project and make sure in can be found (in
> > my example the ):
> >
> > in DoxyFile:
> > EXAMPLE_PATH = web/test \
> > documentation/htmlincludes/ \
> >
> >
> > In the source, I create pages:
> > /// @page soap11 The SOAP specification, version 1.1
> > /// @htmlinclude SOAP_1_1.html
> >
> > /// @page soap12 The SOAP specification, version 1.2
> > /// @htmlinclude SOAP_1_2.html
> >
> > /// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages
> > /// @htmlinclude stylesandencodingsinsoap.html
> >
> > /// @page wsdl11 Web Service Description Language
> > /// @htmlinclude WSDL_1_1.html
> >
> >
> > The files referred to in the @htmlinclude commands are in
> > documentation/htmlincludes/ .
> >
> > Best regards,
> > Willem Bogaerts
> >
> >
> >
> >
> ------------------------------------------------------------------------------
> > Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> > Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> > Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> > Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
> >
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
>
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
|
|
From: Tom J. <tom...@gm...> - 2014-10-06 15:34:23
|
Interesting technique. Thanks for the tip. I probably have too many pages to make this technique practical, but it's good to know you can do this sort of thing in doxygen. Tom --------------------- 801-822-2241 blog: idratherbewriting.com twitter: tomjohnson On Sun, Oct 5, 2014 at 10:37 AM, Albert <alb...@gm...> wrote: > I had a similar problem, only that I wanted just a file with a table rows > to be read into a page. I used the following trick: > > \htmlonly > <script src="jquery.js"></script> > <script> > $(function(){ > $("#includedContent").load("file.html"); > }); > </script> > > <table class="doxtable"> > <thead> > <tr> > <th>File</th> > <th>Line</th> > <th>Message</th> > </tr> > </thead> > <tbody id="includedContent"> > </tbody> > </table> > \endhtmlonly > > One is self responsible for everything and there won't be any links > generated by doxygen when it is generated. > > Doxygen is not able to interpret the entire HTML pages, but maybe > translating the HTML to e.g. md and than feeding this to doxygen might give > a possibility. See e.g. pandoc (http://johnmacfarlane.net/pandoc/), I > have no experience with it so I don't know how easy it can be used and what > the quality of the results will be. > > Albert > > On Fri, Oct 3, 2014 at 9:42 PM, Tom Johnson <tom...@gm...> > wrote: > >> Any other ideas on how to get doxygen to include standalone html files? I >> was really hoping to find a solution for merging source-generated doc with >> other tutorial doc. >> >> Tom >> >> Sent from my iPhone >> >> > On Oct 1, 2014, at 3:45 AM, Willem Bogaerts <w-...@dd...> wrote: >> > >> > Dear Tom, >> > >> > I used this to include RFCs in my documentation. To do this, copy the >> > HTML files somewhere in your project and make sure in can be found (in >> > my example the ): >> > >> > in DoxyFile: >> > EXAMPLE_PATH = web/test \ >> > documentation/htmlincludes/ \ >> > >> > >> > In the source, I create pages: >> > /// @page soap11 The SOAP specification, version 1.1 >> > /// @htmlinclude SOAP_1_1.html >> > >> > /// @page soap12 The SOAP specification, version 1.2 >> > /// @htmlinclude SOAP_1_2.html >> > >> > /// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages >> > /// @htmlinclude stylesandencodingsinsoap.html >> > >> > /// @page wsdl11 Web Service Description Language >> > /// @htmlinclude WSDL_1_1.html >> > >> > >> > The files referred to in the @htmlinclude commands are in >> > documentation/htmlincludes/ . >> > >> > Best regards, >> > Willem Bogaerts >> > >> > >> > >> > >> ------------------------------------------------------------------------------ >> > Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer >> > Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports >> > Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper >> > Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer >> > >> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk >> > _______________________________________________ >> > Doxygen-users mailing list >> > Dox...@li... >> > https://lists.sourceforge.net/lists/listinfo/doxygen-users >> >> >> ------------------------------------------------------------------------------ >> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer >> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports >> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper >> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer >> >> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk >> _______________________________________________ >> Doxygen-users mailing list >> Dox...@li... >> https://lists.sourceforge.net/lists/listinfo/doxygen-users >> > > |
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X