Quantcast

Configuring the RTF output

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Configuring the RTF output

Celine Boutet
I need to produce an MS Word documentation for my VHDL code that
complies with the documents template of my company.
To achieve this goal I was able to configure several things but I still
need a lot of human actions so I wonder if someone tried to do something
like that and was able to fully automate the process.

To be more specific, here is what I do :
* I use a configuration file (named "Doxyfile_fpga") with my project
name, project number, link to the logo, the input folder and list of
files to exclude, etc.
* I use an RTF style sheet (named "rtfstyle_fpga.cfg") to configure the
RTF output. I needed to change the level of headers because the
documentation of the code is only a sub-part of my document. So Heading1
uses the style "heading 2" and so on. The DescContinue styles also
generated bad looking output so all DescContinueN styles lead to the
Normal style. Same for BodyText and DenseText.
* I use a layout file (named "DoxygenLayout_fpga.xml"). I was hoping
that I could configure the content of my RTF output with it but it only
allows me to rename the "Architectures" section in "Units" section... In
fact I think the content of each section is ok for me, but I would like
not to display whole sections and I have not found how to do it.
* I run Doxygen with all these files (using the Doxywizard). It gives me
an RTF named refman.rtf and many images in an "rtf" folder.
Note: I use a custom version of Doxygen because for VHDL the lists where
not correctly displayed in the RTF output (see
https://bugzilla.gnome.org/show_bug.cgi?id=650880). I made a patch but I
applied it on a 1.7.4 version because the 1.7.5 version doesn't find the
target of my @copydoc commands (see
https://sourceforge.net/projects/doxygen/forums/forum/130994/topic/4659187
and https://bugzilla.gnome.org/show_bug.cgi?id=656644), and I use a lot
of @copydoc commands...
* I open this RTF file in MS Word 2010, I apply my company style set
(Home/Change Styles/Style set/My_style).
* I then embed all the images : File/Info/ "Edit links to Files" (in the
bottom right), I selected all the pictures and select "Break link".
* Then I delete the first pages and the several tables of contents to
keep only the "class documentation" and "file documentation".
* I copy all the documentation that remains.
* Then I open my company document template, and I paste the modified
Doxygen documentation at the end.
* My company template includes header and footer and usually the
copy-paste of the Doxygen documentation makes them disappear so I have
to manually copy-paste them back.

I am sure the process can be simplified. If someone has any idea...

Céline.

------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2dcopy1
_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: Configuring the RTF output

Celine Boutet
Thanks a lot for your answer Larry.
I don't use a .dot file but my styles are in the "Quick style set" list.
The styles I use are the built-in styles named "Heading 1", "Heading
2"... but with a special Word 2010 theme that makes the Normal style to
use Calibri police for instance.
If I understand well, to apply your method I need to create a .dot with
my styles redefined with a custom name and then to attach this template
to the refman.rtf when I open it in Word ? Or is it a way to
automatically attach the template ?
If I have to manually attach the template it seems quicker to apply the
"style set" from the "Quick Style set" list, or do I miss something ?

Céline.


Le 27/09/2011 12:14, Randall, Larry a écrit :

>  
> Hi, Celine,
>
> You can easily modify the style sheet to map the Doxygen styles to your styles.  If you have a Word Template (.dot file), you can attach that and it will auto-convert the style named at far right in the example below (i.e., 2_Heading) to the style of the same name that is in the attached .dot file.  This is the easiest way to instantly convert to your defined styles.
>
> NOTE:  A .dot file is NOT used directly to create a document.  It is a repository of styles, only.  Using a .dot file directly to create documents creates extreme issues in Word.  Adding and ttaching the .dot file allows the user to use a TRUE "document template" (i.e, a "base document") while having defined styles.  My .dot file also features toolbars that allow one-click application of styles - a task that is very complicated if done from the Word interface.
>
> Unmodified:
> # Heading1 = \s1\sb240\sa60\keepn\widctlpar\adjustright \b\f1\fs36\kerning36\cgrid \sbasedon0 \snext0 heading 1
> # Heading2 = \s2\sb240\sa60\keepn\widctlpar\adjustright \b\f1\fs28\kerning28\cgrid \sbasedon0 \snext0 heading 2
>
> From my stylesheet:
>  Heading1 = \s1\sb240\sa60\keepn\widctlpar\adjustright \b\f1\fs36\kerning36\cgrid \sbasedon0 \snext0 2_Heading
>  Heading2 = \s2\sb240\sa60\keepn\widctlpar\adjustright \b\f1\fs28\kerning28\cgrid \sbasedon0 \snext0 3_Heading
>
> Regards,
> Larry Randall
> Program Manager, OMAPT Platforms Logistics & Reliability
> Office:  214-567-5735    Mobile: 214-536-0325
> [hidden email]
>
> -----Original Message-----
> From: Celine Boutet [mailto:[hidden email]]
> Sent: Tuesday, September 27, 2011 04:39
> To: [hidden email]
> Subject: [Doxygen-users] Configuring the RTF output
>
> I need to produce an MS Word documentation for my VHDL code that complies with the documents template of my company.
> To achieve this goal I was able to configure several things but I still need a lot of human actions so I wonder if someone tried to do something like that and was able to fully automate the process.
>
> To be more specific, here is what I do :
> * I use a configuration file (named "Doxyfile_fpga") with my project name, project number, link to the logo, the input folder and list of files to exclude, etc.
> * I use an RTF style sheet (named "rtfstyle_fpga.cfg") to configure the RTF output. I needed to change the level of headers because the documentation of the code is only a sub-part of my document. So Heading1 uses the style "heading 2" and so on. The DescContinue styles also generated bad looking output so all DescContinueN styles lead to the Normal style. Same for BodyText and DenseText.
> * I use a layout file (named "DoxygenLayout_fpga.xml"). I was hoping that I could configure the content of my RTF output with it but it only allows me to rename the "Architectures" section in "Units" section... In fact I think the content of each section is ok for me, but I would like not to display whole sections and I have not found how to do it.
> * I run Doxygen with all these files (using the Doxywizard). It gives me an RTF named refman.rtf and many images in an "rtf" folder.
> Note: I use a custom version of Doxygen because for VHDL the lists where not correctly displayed in the RTF output (see https://bugzilla.gnome.org/show_bug.cgi?id=650880). I made a patch but I applied it on a 1.7.4 version because the 1.7.5 version doesn't find the target of my @copydoc commands (see
> https://sourceforge.net/projects/doxygen/forums/forum/130994/topic/4659187
> and https://bugzilla.gnome.org/show_bug.cgi?id=656644), and I use a lot of @copydoc commands...
> * I open this RTF file in MS Word 2010, I apply my company style set (Home/Change Styles/Style set/My_style).
> * I then embed all the images : File/Info/ "Edit links to Files" (in the bottom right), I selected all the pictures and select "Break link".
> * Then I delete the first pages and the several tables of contents to keep only the "class documentation" and "file documentation".
> * I copy all the documentation that remains.
> * Then I open my company document template, and I paste the modified Doxygen documentation at the end.
> * My company template includes header and footer and usually the copy-paste of the Doxygen documentation makes them disappear so I have to manually copy-paste them back.
>
> I am sure the process can be simplified. If someone has any idea...
>
> Céline.
>
> ------------------------------------------------------------------------------
> All the data continuously generated in your IT infrastructure contains a definitive record of customers, application performance, security threats, fraudulent activity and more. Splunk takes this data and makes sense of it. Business sense. IT sense. Common sense.
> http://p.sf.net/sfu/splunk-d2dcopy1
> _______________________________________________
> Doxygen-users mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2dcopy1
_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: Configuring the RTF output

Randall, Larry
Hi,

I have latest Word on my home computer, but never use it.  (Wordperfect is WAY easier and does more -- because is a true word processor, not just RTF with Windows make-up on.)  On my work computer, I am using 2003 because of the fact that MS took away functionality in 2010 that allows linkage between Excel and Sharepoint.  That functionality is vital to our business.

To add and attach the template, hit ALT, T, I.  Done in 5 seconds or less....

Regards,
Larry Randall
Program Manager, OMAPT Platforms Logistics & Reliability
Office:  214-567-5735    Mobile: 214-536-0325
[hidden email]

-----Original Message-----
From: Celine Boutet [mailto:[hidden email]]
Sent: Tuesday, September 27, 2011 07:04
To: [hidden email]
Subject: Re: [Doxygen-users] Configuring the RTF output

Thanks a lot for your answer Larry.
I don't use a .dot file but my styles are in the "Quick style set" list.
The styles I use are the built-in styles named "Heading 1", "Heading 2"... but with a special Word 2010 theme that makes the Normal style to use Calibri police for instance.
If I understand well, to apply your method I need to create a .dot with my styles redefined with a custom name and then to attach this template to the refman.rtf when I open it in Word ? Or is it a way to automatically attach the template ?
If I have to manually attach the template it seems quicker to apply the "style set" from the "Quick Style set" list, or do I miss something ?

Céline.


Le 27/09/2011 12:14, Randall, Larry a écrit :

>  
> Hi, Celine,
>
> You can easily modify the style sheet to map the Doxygen styles to your styles.  If you have a Word Template (.dot file), you can attach that and it will auto-convert the style named at far right in the example below (i.e., 2_Heading) to the style of the same name that is in the attached .dot file.  This is the easiest way to instantly convert to your defined styles.
>
> NOTE:  A .dot file is NOT used directly to create a document.  It is a repository of styles, only.  Using a .dot file directly to create documents creates extreme issues in Word.  Adding and ttaching the .dot file allows the user to use a TRUE "document template" (i.e, a "base document") while having defined styles.  My .dot file also features toolbars that allow one-click application of styles - a task that is very complicated if done from the Word interface.
>
> Unmodified:
> # Heading1 = \s1\sb240\sa60\keepn\widctlpar\adjustright
> \b\f1\fs36\kerning36\cgrid \sbasedon0 \snext0 heading 1 # Heading2 =
> \s2\sb240\sa60\keepn\widctlpar\adjustright \b\f1\fs28\kerning28\cgrid
> \sbasedon0 \snext0 heading 2
>
> From my stylesheet:
>  Heading1 = \s1\sb240\sa60\keepn\widctlpar\adjustright
> \b\f1\fs36\kerning36\cgrid \sbasedon0 \snext0 2_Heading
>  Heading2 = \s2\sb240\sa60\keepn\widctlpar\adjustright
> \b\f1\fs28\kerning28\cgrid \sbasedon0 \snext0 3_Heading
>
> Regards,
> Larry Randall
> Program Manager, OMAPT Platforms Logistics & Reliability
> Office:  214-567-5735    Mobile: 214-536-0325
> [hidden email]
>
> -----Original Message-----
> From: Celine Boutet [mailto:[hidden email]]
> Sent: Tuesday, September 27, 2011 04:39
> To: [hidden email]
> Subject: [Doxygen-users] Configuring the RTF output
>
> I need to produce an MS Word documentation for my VHDL code that complies with the documents template of my company.
> To achieve this goal I was able to configure several things but I still need a lot of human actions so I wonder if someone tried to do something like that and was able to fully automate the process.
>
> To be more specific, here is what I do :
> * I use a configuration file (named "Doxyfile_fpga") with my project name, project number, link to the logo, the input folder and list of files to exclude, etc.
> * I use an RTF style sheet (named "rtfstyle_fpga.cfg") to configure the RTF output. I needed to change the level of headers because the documentation of the code is only a sub-part of my document. So Heading1 uses the style "heading 2" and so on. The DescContinue styles also generated bad looking output so all DescContinueN styles lead to the Normal style. Same for BodyText and DenseText.
> * I use a layout file (named "DoxygenLayout_fpga.xml"). I was hoping that I could configure the content of my RTF output with it but it only allows me to rename the "Architectures" section in "Units" section... In fact I think the content of each section is ok for me, but I would like not to display whole sections and I have not found how to do it.
> * I run Doxygen with all these files (using the Doxywizard). It gives me an RTF named refman.rtf and many images in an "rtf" folder.
> Note: I use a custom version of Doxygen because for VHDL the lists
> where not correctly displayed in the RTF output (see
> https://bugzilla.gnome.org/show_bug.cgi?id=650880). I made a patch but
> I applied it on a 1.7.4 version because the 1.7.5 version doesn't find
> the target of my @copydoc commands (see
> https://sourceforge.net/projects/doxygen/forums/forum/130994/topic/465
> 9187 and https://bugzilla.gnome.org/show_bug.cgi?id=656644), and I use
> a lot of @copydoc commands...
> * I open this RTF file in MS Word 2010, I apply my company style set (Home/Change Styles/Style set/My_style).
> * I then embed all the images : File/Info/ "Edit links to Files" (in the bottom right), I selected all the pictures and select "Break link".
> * Then I delete the first pages and the several tables of contents to keep only the "class documentation" and "file documentation".
> * I copy all the documentation that remains.
> * Then I open my company document template, and I paste the modified Doxygen documentation at the end.
> * My company template includes header and footer and usually the copy-paste of the Doxygen documentation makes them disappear so I have to manually copy-paste them back.
>
> I am sure the process can be simplified. If someone has any idea...
>
> Céline.
>
> ----------------------------------------------------------------------
> -------- All the data continuously generated in your IT infrastructure
> contains a definitive record of customers, application performance, security threats, fraudulent activity and more. Splunk takes this data and makes sense of it. Business sense. IT sense. Common sense.
> http://p.sf.net/sfu/splunk-d2dcopy1
> _______________________________________________
> Doxygen-users mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure contains a definitive record of customers, application performance, security threats, fraudulent activity and more. Splunk takes this data and makes sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2dcopy1
_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users

------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2dcopy1
_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: Configuring the RTF output

Celine Boutet
Thanks for the short-cut, the feature is quite well hidden in the Word
2010 menus ! I keep the idea to apply my custom styles to the Doxygen's
RTF output. Thanks.

Céline BOUTET
Ingénieur Développement FPGA
Axess Europe
31100 TOULOUSE

Le 27/09/2011 17:53, Randall, Larry a écrit :

> Hi,
>
> I have latest Word on my home computer, but never use it.  (Wordperfect is WAY easier and does more -- because is a true word processor, not just RTF with Windows make-up on.)  On my work computer, I am using 2003 because of the fact that MS took away functionality in 2010 that allows linkage between Excel and Sharepoint.  That functionality is vital to our business.
>
> To add and attach the template, hit ALT, T, I.  Done in 5 seconds or less....
>
> Regards,
> Larry Randall
> Program Manager, OMAPT Platforms Logistics & Reliability
> Office:  214-567-5735    Mobile: 214-536-0325
> [hidden email]
>
> -----Original Message-----
> From: Celine Boutet [mailto:[hidden email]]
> Sent: Tuesday, September 27, 2011 07:04
> To: [hidden email]
> Subject: Re: [Doxygen-users] Configuring the RTF output
>
> Thanks a lot for your answer Larry.
> I don't use a .dot file but my styles are in the "Quick style set" list.
> The styles I use are the built-in styles named "Heading 1", "Heading 2"... but with a special Word 2010 theme that makes the Normal style to use Calibri police for instance.
> If I understand well, to apply your method I need to create a .dot with my styles redefined with a custom name and then to attach this template to the refman.rtf when I open it in Word ? Or is it a way to automatically attach the template ?
> If I have to manually attach the template it seems quicker to apply the "style set" from the "Quick Style set" list, or do I miss something ?
>
> Céline.
>
>
> Le 27/09/2011 12:14, Randall, Larry a écrit :
>>  
>> Hi, Celine,
>>
>> You can easily modify the style sheet to map the Doxygen styles to your styles.  If you have a Word Template (.dot file), you can attach that and it will auto-convert the style named at far right in the example below (i.e., 2_Heading) to the style of the same name that is in the attached .dot file.  This is the easiest way to instantly convert to your defined styles.
>>
>> NOTE:  A .dot file is NOT used directly to create a document.  It is a repository of styles, only.  Using a .dot file directly to create documents creates extreme issues in Word.  Adding and ttaching the .dot file allows the user to use a TRUE "document template" (i.e, a "base document") while having defined styles.  My .dot file also features toolbars that allow one-click application of styles - a task that is very complicated if done from the Word interface.
>>
>> Unmodified:
>> # Heading1 = \s1\sb240\sa60\keepn\widctlpar\adjustright
>> \b\f1\fs36\kerning36\cgrid \sbasedon0 \snext0 heading 1 # Heading2 =
>> \s2\sb240\sa60\keepn\widctlpar\adjustright \b\f1\fs28\kerning28\cgrid
>> \sbasedon0 \snext0 heading 2
>>
>> From my stylesheet:
>>  Heading1 = \s1\sb240\sa60\keepn\widctlpar\adjustright
>> \b\f1\fs36\kerning36\cgrid \sbasedon0 \snext0 2_Heading
>>  Heading2 = \s2\sb240\sa60\keepn\widctlpar\adjustright
>> \b\f1\fs28\kerning28\cgrid \sbasedon0 \snext0 3_Heading
>>
>> Regards,
>> Larry Randall
>> Program Manager, OMAPT Platforms Logistics & Reliability
>> Office:  214-567-5735    Mobile: 214-536-0325
>> [hidden email]
>>
>> -----Original Message-----
>> From: Celine Boutet [mailto:[hidden email]]
>> Sent: Tuesday, September 27, 2011 04:39
>> To: [hidden email]
>> Subject: [Doxygen-users] Configuring the RTF output
>>
>> I need to produce an MS Word documentation for my VHDL code that complies with the documents template of my company.
>> To achieve this goal I was able to configure several things but I still need a lot of human actions so I wonder if someone tried to do something like that and was able to fully automate the process.
>>
>> To be more specific, here is what I do :
>> * I use a configuration file (named "Doxyfile_fpga") with my project name, project number, link to the logo, the input folder and list of files to exclude, etc.
>> * I use an RTF style sheet (named "rtfstyle_fpga.cfg") to configure the RTF output. I needed to change the level of headers because the documentation of the code is only a sub-part of my document. So Heading1 uses the style "heading 2" and so on. The DescContinue styles also generated bad looking output so all DescContinueN styles lead to the Normal style. Same for BodyText and DenseText.
>> * I use a layout file (named "DoxygenLayout_fpga.xml"). I was hoping that I could configure the content of my RTF output with it but it only allows me to rename the "Architectures" section in "Units" section... In fact I think the content of each section is ok for me, but I would like not to display whole sections and I have not found how to do it.
>> * I run Doxygen with all these files (using the Doxywizard). It gives me an RTF named refman.rtf and many images in an "rtf" folder.
>> Note: I use a custom version of Doxygen because for VHDL the lists
>> where not correctly displayed in the RTF output (see
>> https://bugzilla.gnome.org/show_bug.cgi?id=650880). I made a patch but
>> I applied it on a 1.7.4 version because the 1.7.5 version doesn't find
>> the target of my @copydoc commands (see
>> https://sourceforge.net/projects/doxygen/forums/forum/130994/topic/465
>> 9187 and https://bugzilla.gnome.org/show_bug.cgi?id=656644), and I use
>> a lot of @copydoc commands...
>> * I open this RTF file in MS Word 2010, I apply my company style set (Home/Change Styles/Style set/My_style).
>> * I then embed all the images : File/Info/ "Edit links to Files" (in the bottom right), I selected all the pictures and select "Break link".
>> * Then I delete the first pages and the several tables of contents to keep only the "class documentation" and "file documentation".
>> * I copy all the documentation that remains.
>> * Then I open my company document template, and I paste the modified Doxygen documentation at the end.
>> * My company template includes header and footer and usually the copy-paste of the Doxygen documentation makes them disappear so I have to manually copy-paste them back.
>>
>> I am sure the process can be simplified. If someone has any idea...
>>
>> Céline.
>>
>> ----------------------------------------------------------------------
>> -------- All the data continuously generated in your IT infrastructure
>> contains a definitive record of customers, application performance, security threats, fraudulent activity and more. Splunk takes this data and makes sense of it. Business sense. IT sense. Common sense.
>> http://p.sf.net/sfu/splunk-d2dcopy1
>> _______________________________________________
>> Doxygen-users mailing list
>> [hidden email]
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
> ------------------------------------------------------------------------------
> All the data continuously generated in your IT infrastructure contains a definitive record of customers, application performance, security threats, fraudulent activity and more. Splunk takes this data and makes sense of it. Business sense. IT sense. Common sense.
> http://p.sf.net/sfu/splunk-d2dcopy1
> _______________________________________________
> Doxygen-users mailing list
> [hidden email]
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2dcopy1
_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Loading...