Modules book title: possible to rename ?

View: New views
4 Messages — Rating Filter:   Alert me  

Modules book title: possible to rename ?

by Martin Moene :: Rate this Message:

| View Threaded | Show Only this Message

Dear Doxygen users,

I'm wondering if it is possible to rename the [+] Modules book as
presented in the compressed hypertext help (CHM) file to something of my
own choice.

The idea is probably easiest shown with a 'picture'.

The 'default' CHM File Contents:

[=] ApplicationName
[+] Modules
    [+] ApplicationName Project
        <group__group__camera__project__plan.html>[+]
<group__group__camera__project__plan.html>Project Plan
<group__group__camera__project__plan.html>
  <group__group__camera__requirements.html>  
<group__group__camera__requirements.html>    
<group__group__camera__requirements.html>[+]
<group__group__camera__requirements.html>Requirements
<group__group__camera__requirements.html>
    <group__group__camera__sdd.html>    
<group__group__camera__requirements.html>[+]
<group__group__camera__sdd.html>System Description
<group__group__camera__sdd.html>
    <group__group__camera__user__manual.html>    
<group__group__camera__requirements.html>[+]
<group__group__camera__user__manual.html>User Manual
<group__group__camera__user__manual.html>
    <group__group__camera__modules.html>    
<group__group__camera__requirements.html>[+]
<group__group__camera__modules.html>ApplicationName Modules
<group__group__camera__modules.html>
    <group__group__camera__coding__standard.html>    
<group__group__camera__requirements.html>[+]
<group__group__camera__coding__standard.html>Coding Standard
<group__group__camera__coding__standard.html>
    <group__group__camera__references.html>    
<group__group__camera__requirements.html>[=] References
<group__group__camera__references.html>

I'd rather like the Contents to read:

[=] ApplicationName
[+] ApplicationName Project
    <group__group__camera__project__plan.html>[+]
<group__group__camera__project__plan.html>Project Plan
<group__group__camera__project__plan.html>
    <group__group__camera__requirements.html>[+]
<group__group__camera__requirements.html>Requirements
<group__group__camera__requirements.html>
    <group__group__camera__requirements.html>[+]
<group__group__camera__sdd.html>System Description
<group__group__camera__sdd.html>
    <group__group__camera__requirements.html>[+]
<group__group__camera__user__manual.html>User Manual
<group__group__camera__user__manual.html>
    <group__group__camera__requirements.html>[+] ApplicationName
<group__group__camera__modules.html>Modules
<group__group__camera__modules.html>
    <group__group__camera__requirements.html>[+]
<group__group__camera__coding__standard.html>Coding Standard
<group__group__camera__coding__standard.html>
    <group__group__camera__requirements.html>[=] References
<group__group__camera__references.html>

The modules book --renamed ApplicationName Project-- will only contain
modules.

I had a quick look in the Doxygen help, the FAQ and Google( how to
(re)name the html modules in doxygen ), but did not find anything close
to an answer.

Thanks for any help.

Martin.

--
__________________________________________________________________________

 Martin Moene
 mailto:m.j.moene@...            T: +31 71 527 5960
 http://www.eld.physics.LeidenUniv.nl/~moene/          F: +31 71 527 1542

 Electronics Department | Leiden Institute of Physics | Leiden University
__________________________________________________________________________


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Modules book title: possible to rename ? [cleaned-up]

by Martin Moene :: Rate this Message:

| View Threaded | Show Only this Message

[Sorry for the clutter in the original post]

Dear Doxygen users,

I'm wondering if it is possible to rename the [+] Modules book as
presented in the compressed hypertext help (CHM) file to something of my
own choice.

The idea is probably easiest shown with a 'picture'.

The 'default' CHM File Contents:

[=] ApplicationName
[+] Modules
    [+] ApplicationName Project
        [+] Project Plan
        [+] Requirements
        [+] System Description
        [+] User Manual
        [+] ApplicationName Modules
        [+] Coding Standard
        [=] References

I'd rather like the Contents to read:

[=] ApplicationName
[+] ApplicationName Project
    [+] Project Plan
    [+] Requirements
    [+] System Description
    [+] User Manual
    [+] ApplicationName Modules
    [+] Coding Standard
    [=] References

The modules book --renamed ApplicationName Project-- will only contain
modules.

I had a quick look in the Doxygen help, the FAQ and Google( how to
(re)name the html modules in doxygen ), but did not find anything close
to an answer.

Thanks for any help.

Martin.

--
__________________________________________________________________________

Martin Moene
mailto:m.j.moene@...            T: +31 71 527 5960
http://www.eld.physics.LeidenUniv.nl/~moene/          F: +31 71 527 1542

Electronics Department | Leiden Institute of Physics | Leiden University
__________________________________________________________________________


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: Modules book title: possible to rename ? [cleaned-up]

by Jake Colman :: Rate this Message:

| View Threaded | Show Only this Message

>>>>> "MJM" == Martin J Moene <m.j.moene@...> writes:

   MJM> [Sorry for the clutter in the original post]
   MJM> Dear Doxygen users,

   MJM> I'm wondering if it is possible to rename the [+] Modules book as
   MJM> presented in the compressed hypertext help (CHM) file to something of my
   MJM> own choice.

   MJM> The idea is probably easiest shown with a 'picture'.

   MJM> The 'default' CHM File Contents:

   MJM> [=] ApplicationName
   MJM> [+] Modules
   MJM>     [+] ApplicationName Project
   MJM>         [+] Project Plan
   MJM>         [+] Requirements
   MJM>         [+] System Description
   MJM>         [+] User Manual
   MJM>         [+] ApplicationName Modules
   MJM>         [+] Coding Standard
   MJM>         [=] References

   MJM> I'd rather like the Contents to read:

   MJM> [=] ApplicationName
   MJM> [+] ApplicationName Project
   MJM>     [+] Project Plan
   MJM>     [+] Requirements
   MJM>     [+] System Description
   MJM>     [+] User Manual
   MJM>     [+] ApplicationName Modules
   MJM>     [+] Coding Standard
   MJM>     [=] References

   MJM> The modules book --renamed ApplicationName Project-- will only contain
   MJM> modules.

   MJM> I had a quick look in the Doxygen help, the FAQ and Google( how to
   MJM> (re)name the html modules in doxygen ), but did not find anything close
   MJM> to an answer.

   MJM> Thanks for any help.

   MJM> Martin.

If you are bulding Doxygen from source, then your best bet is to modify
translator_en.h and change the translation.  That is how I changed
"Modules" to "Groups" in all places where the work "module" appeared.


--
Jake Colman
Director of Software Development
Principia Partners LLC
101 West Elm Street
Suite 620
Conshohocken, PA  19428
+1 (610) 755-9786
www.principiapartners.com

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: change/customize/alternate/different name for Modules section: summary of similar questions

by Martin Moene :: Rate this Message:

| View Threaded | Show Only this Message

Martin J. Moene wrote:

> [Sorry for the clutter in the original post]
>
> Dear Doxygen users,
>
> I'm wondering if it is possible to rename the [+] Modules book as
> presented in the compressed hypertext help (CHM) file to something of my
> own choice.
>
> The idea is probably easiest shown with a 'picture'.
>
> The 'default' CHM File Contents:
>
> [=] ApplicationName
> [+] Modules
>     [+] ApplicationName Project
>         [+] Project Plan
>         [+] Requirements
>         [+] System Description
>         [+] User Manual
>         [+] ApplicationName Modules
>         [+] Coding Standard
>         [=] References
>
> I'd rather like the Contents to read:
>
> [=] ApplicationName
> [+] ApplicationName Project
>     [+] Project Plan
>     [+] Requirements
>     [+] System Description
>     [+] User Manual
>     [+] ApplicationName Modules
>     [+] Coding Standard
>     [=] References
>
> The modules book --renamed ApplicationName Project-- will only contain
> modules.
>
> I had a quick look in the Doxygen help, the FAQ and Google( how to
> (re)name the html modules in doxygen ), but did not find anything close
> to an answer.
>
> Thanks for any help.
>  
A small search in the doxygen-users list, reveals that several similar
questions were asked before (somehow, strangely enough, I didn't search
this list).

Search(+name +modules change customize adapt rename) AND
ml_name:(doxygen-users):

    * [Doxygen-users] Changing Name of Modules Section,  Jake Colman,
      2006-11-15
      http://sourceforge.net/mailarchive/message.php?msg_id=767ixwh6a1.fsf%40pennsylvania.ppllc.com
    * Re: [Doxygen-users] Different term than "modules" , David
      Whiteman, 2006-06-15
      http://sourceforge.net/mailarchive/message.php?msg_id=63234021625.20060615104528%40alumni.ncsu.edu
    * [Doxygen-users] Feature Request: Alternative to "Modules" for the
      grouping title, Tom Rolfs, 2005-10-21
      http://sourceforge.net/mailarchive/message.php?msg_name=1968680175.20051020200552%40cox.net
    * [Doxygen-users] "Modules" name change, Daniel Schnell, 2003-03-04
      http://sourceforge.net/mailarchive/message.php?msg_id=005f01c2e22c%24cfcc3420%24a100a8c0%40Lumpidu

Also found:

    * [Doxygen-users] customize naming of contents categories in chm
      file, Julia Gilinets, 2006-10-12
      http://sourceforge.net/mailarchive/message.php?msg_id=f279dff60610121302w5135d857g795e4e6075ec727a%40mail.gmail.com

Some people (e.g. Jake Colman) solve the request by modifying
translator_en.h and changing the translation and recompiling doxygen for
example to change Modules to Groups.

In my situation, the Modules section would get a different name for each
project. and changing and recompiling doxygen for that purpose is a
little too much effort to consider it.

Apart from the described solution, I didn't find any other ways to
change the name of the Modules section.

Maybe a real solution to the requested feature lies in Doxygen TODO/Wish
list number 10:

    http://www.stack.nl/~dimitri/doxygen/todo.html:

    Make doxygen much more configurable by adding an interpreter that
    reads a template file (one for each output format) and generates
    output based on text and special commands/constructs in that
    template file. Or use an approach that is similar to Java Doclets.
        Est. Difficulty (1:low-10:high): 10

Martin.

--
__________________________________________________________________________

 Martin Moene
 mailto:m.j.moene@...            T: +31 71 527 5960
 http://www.eld.physics.LeidenUniv.nl/~moene/          F: +31 71 527 1542

 Electronics Department | Leiden Institute of Physics | Leiden University
__________________________________________________________________________


-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users