[Insight-users] Doxygen Documentation is Difficult to Read - DoxygenStyle.css file needs to be changed
Bill Lorensen
bill.lorensen at gmail.com
Wed Jul 29 07:43:41 EDT 2009
I agree, the new layout is a huge improvement.
Thanks Mike,
Bill
On Wed, Jul 29, 2009 at 4:05 AM, Matthias
Keil<matthias.keil at igd.fraunhofer.de> wrote:
> Hi Bill,
>
> the duplicates existed already before changing to the new layout, as you can
> see here in the ITK 3.12 documentation:
>
> http://www.itk.org/Doxygen312/html/hierarchy.html
>
> This seems to be a different problem in generating the Doxygen documentation
> and not the display using the .css files.
>
> Therefore I think that using the new layout is a big improvement for the
> documentation! Thanks to Michael for this patch!
>
> Best,
> Matthias
>
> Bill Lorensen schrieb:
>>
>> Luis,
>>
>> I also see duplicates of many classes in the hierarchy list:
>>
>> http://www.itk.org/Doxygen314/html/hierarchy.html
>>
>> for example itk::TransformFileReader and itk::TransformFileWriter
>>
>> Bill
>>
>> On Tue, Jul 28, 2009 at 10:29 PM, Luis Ibanez<luis.ibanez at kitware.com>
>> wrote:
>>>
>>> Hi Michael,
>>>
>>> I have replaced the the DoxygenStyle.css file with
>>> the one that you kindly provided.
>>>
>>> However,
>>> it doesn't quite look as the one you posted...
>>>
>>> Could you please take a look at
>>> http://www.itk.org/Doxygen314/html/index.html
>>>
>>>
>>> and confirm if this is the expected formatting ?
>>>
>>>
>>> Thanks
>>>
>>>
>>> Luis
>>>
>>>
>>> ----------------------------------------------------
>>> On Tue, Jul 28, 2009 at 9:04 AM, Michael Jackson
>>> <mike.jackson at bluequartz.net> wrote:
>>>>
>>>> Thanks Luis, Appreciate the help.
>>>> ---
>>>> Mike Jackson www.bluequartz.net
>>>>
>>>>
>>>>
>>>> On Jul 28, 2009, at 8:30 AM, Luis Ibanez wrote:
>>>>
>>>>> Michael, Gaetan,
>>>>>
>>>>> Thanks a lot for looking at this improvement.
>>>>>
>>>>> I'll give it a shot (later today) at replacing the .css file.
>>>>>
>>>>>
>>>>> Luis
>>>>>
>>>>>
>>>>>
>>>>> --------------------------------------------------------
>>>>> On Wed, Jul 22, 2009 at 12:20 PM, Michael Jackson
>>>>> <mike.jackson at bluequartz.net> wrote:
>>>>>
>>>>> On Jul 22, 2009, at 12:13 PM, Gaëtan Lehmann wrote:
>>>>>
>>>>>
>>>>> Le 22 juil. 09 à 17:29, Michael Jackson a écrit :
>>>>>
>>>>> Over the last day I have had to dive deep into the ITK Doxygen
>>>>> documentation and I have found it extremely difficult to read simply
>>>>> due to
>>>>> the formatting that has been applied. As I use Doxygen in some of my
>>>>> other
>>>>> projects I and that documentation is formatted in a reasonable manner I
>>>>> figured I would take a minute and figure out what the problem might be.
>>>>> Turns out the CSS style sheet that Doxygen generates for my projects is
>>>>> vastly different from that produced for the ITK project. I am attaching
>>>>> 2
>>>>> images that show the difference. Looks like the default CSS sheet is
>>>>> configured from ITK_ROOT/Documentation/Doxygen/DoxygenStyle.css. Can
>>>>> this be
>>>>> changed please? Do I need to file a feature request?
>>>>>
>>>>>
>>>>> That's a *huge* improvement!
>>>>> Can you provide a patch?
>>>>>
>>>>> Gaëtan
>>>>>
>>>>>
>>>>> --
>>>>> Gaëtan Lehmann
>>>>> Biologie du Développement et de la Reproduction
>>>>> INRA de Jouy-en-Josas (France)
>>>>> tel: +33 1 34 65 29 66 fax: 01 34 65 29 09
>>>>> http://voxel.jouy.inra.fr http://www.itk.org
>>>>> http://www.mandriva.org http://www.bepo.fr
>>>>>
>>>>>
>>>>> Replace the contents of
>>>>> "ITK_ROOT/Documentation/Doxygen/DoxygenStyle.css"
>>>>> with the following:
>>>>>
>>>>>
>>>>> BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV {
>>>>> font-family: Geneva, Arial, Helvetica, sans-serif;
>>>>> }
>>>>> BODY,TD {
>>>>> font-size: 90%;
>>>>> }
>>>>> H1 {
>>>>> text-align: center;
>>>>> font-size: 160%;
>>>>> }
>>>>> H2 {
>>>>> font-size: 120%;
>>>>> }
>>>>> H3 {
>>>>> font-size: 100%;
>>>>> }
>>>>> CAPTION { font-weight: bold }
>>>>> DIV.qindex {
>>>>> width: 100%;
>>>>> background-color: #e8eef2;
>>>>> border: 1px solid #84b0c7;
>>>>> text-align: center;
>>>>> margin: 2px;
>>>>> padding: 2px;
>>>>> line-height: 140%;
>>>>> }
>>>>> DIV.nav {
>>>>> width: 100%;
>>>>> background-color: #e8eef2;
>>>>> border: 1px solid #84b0c7;
>>>>> text-align: center;
>>>>> margin: 2px;
>>>>> padding: 2px;
>>>>> line-height: 140%;
>>>>> }
>>>>> DIV.navtab {
>>>>> background-color: #e8eef2;
>>>>> border: 1px solid #84b0c7;
>>>>> text-align: center;
>>>>> margin: 2px;
>>>>> margin-right: 15px;
>>>>> padding: 2px;
>>>>> }
>>>>> TD.navtab {
>>>>> font-size: 70%;
>>>>> }
>>>>> A.qindex {
>>>>> text-decoration: none;
>>>>> font-weight: bold;
>>>>> color: #1A419D;
>>>>> }
>>>>> A.qindex:visited {
>>>>> text-decoration: none;
>>>>> font-weight: bold;
>>>>> color: #1A419D
>>>>> }
>>>>> A.qindex:hover {
>>>>> text-decoration: none;
>>>>> background-color: #ddddff;
>>>>> }
>>>>> A.qindexHL {
>>>>> text-decoration: none;
>>>>> font-weight: bold;
>>>>> background-color: #6666cc;
>>>>> color: #ffffff;
>>>>> border: 1px double #9295C2;
>>>>> }
>>>>> A.qindexHL:hover {
>>>>> text-decoration: none;
>>>>> background-color: #6666cc;
>>>>> color: #ffffff;
>>>>> }
>>>>> A.qindexHL:visited { text-decoration: none; background-color: #6666cc;
>>>>> color: #ffffff }
>>>>> A.el { text-decoration: none; font-weight: bold }
>>>>> A.elRef { font-weight: bold }
>>>>> A.code:link { text-decoration: none; font-weight: normal; color:
>>>>> #0000FF}
>>>>> A.code:visited { text-decoration: none; font-weight: normal; color:
>>>>> #0000FF}
>>>>> A.codeRef:link { font-weight: normal; color: #0000FF}
>>>>> A.codeRef:visited { font-weight: normal; color: #0000FF}
>>>>> A:hover { text-decoration: none; background-color: #f2f2ff }
>>>>> DL.el { margin-left: -1cm }
>>>>> .fragment {
>>>>> font-family: monospace, fixed;
>>>>> font-size: 95%;
>>>>> }
>>>>> PRE.fragment {
>>>>> border: 1px solid #CCCCCC;
>>>>> background-color: #f5f5f5;
>>>>> margin-top: 4px;
>>>>> margin-bottom: 4px;
>>>>> margin-left: 2px;
>>>>> margin-right: 8px;
>>>>> padding-left: 6px;
>>>>> padding-right: 6px;
>>>>> padding-top: 4px;
>>>>> padding-bottom: 4px;
>>>>> }
>>>>> DIV.ah { background-color: black; font-weight: bold; color: #ffffff;
>>>>> margin-bottom: 3px; margin-top: 3px }
>>>>>
>>>>> DIV.groupHeader {
>>>>> margin-left: 16px;
>>>>> margin-top: 12px;
>>>>> margin-bottom: 6px;
>>>>> font-weight: bold;
>>>>> }
>>>>> DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% }
>>>>> BODY {
>>>>> background: white;
>>>>> color: black;
>>>>> margin-right: 20px;
>>>>> margin-left: 20px;
>>>>> }
>>>>> TD.indexkey {
>>>>> background-color: #e8eef2;
>>>>> font-weight: bold;
>>>>> padding-right : 10px;
>>>>> padding-top : 2px;
>>>>> padding-left : 10px;
>>>>> padding-bottom : 2px;
>>>>> margin-left : 0px;
>>>>> margin-right : 0px;
>>>>> margin-top : 2px;
>>>>> margin-bottom : 2px;
>>>>> border: 1px solid #CCCCCC;
>>>>> }
>>>>> TD.indexvalue {
>>>>> background-color: #e8eef2;
>>>>> font-style: italic;
>>>>> padding-right : 10px;
>>>>> padding-top : 2px;
>>>>> padding-left : 10px;
>>>>> padding-bottom : 2px;
>>>>> margin-left : 0px;
>>>>> margin-right : 0px;
>>>>> margin-top : 2px;
>>>>> margin-bottom : 2px;
>>>>> border: 1px solid #CCCCCC;
>>>>> }
>>>>> TR.memlist {
>>>>> background-color: #f0f0f0;
>>>>> }
>>>>> P.formulaDsp { text-align: center; }
>>>>> IMG.formulaDsp { }
>>>>> IMG.formulaInl { vertical-align: middle; }
>>>>> SPAN.keyword { color: #008000 }
>>>>> SPAN.keywordtype { color: #604020 }
>>>>> SPAN.keywordflow { color: #e08000 }
>>>>> SPAN.comment { color: #800000 }
>>>>> SPAN.preprocessor { color: #806020 }
>>>>> SPAN.stringliteral { color: #002080 }
>>>>> SPAN.charliteral { color: #008080 }
>>>>> .mdescLeft {
>>>>> padding: 0px 8px 4px 8px;
>>>>> font-size: 80%;
>>>>> font-style: italic;
>>>>> background-color: #FAFAFA;
>>>>> border-top: 1px none #E0E0E0;
>>>>> border-right: 1px none #E0E0E0;
>>>>> border-bottom: 1px none #E0E0E0;
>>>>> border-left: 1px none #E0E0E0;
>>>>> margin: 0px;
>>>>> }
>>>>> .mdescRight {
>>>>> padding: 0px 8px 4px 8px;
>>>>> font-size: 80%;
>>>>> font-style: italic;
>>>>> background-color: #FAFAFA;
>>>>> border-top: 1px none #E0E0E0;
>>>>> border-right: 1px none #E0E0E0;
>>>>> border-bottom: 1px none #E0E0E0;
>>>>> border-left: 1px none #E0E0E0;
>>>>> margin: 0px;
>>>>> }
>>>>> .memItemLeft {
>>>>> padding: 1px 0px 0px 8px;
>>>>> margin: 4px;
>>>>> border-top-width: 1px;
>>>>> border-right-width: 1px;
>>>>> border-bottom-width: 1px;
>>>>> border-left-width: 1px;
>>>>> border-top-color: #E0E0E0;
>>>>> border-right-color: #E0E0E0;
>>>>> border-bottom-color: #E0E0E0;
>>>>> border-left-color: #E0E0E0;
>>>>> border-top-style: solid;
>>>>> border-right-style: none;
>>>>> border-bottom-style: none;
>>>>> border-left-style: none;
>>>>> background-color: #FAFAFA;
>>>>> font-size: 80%;
>>>>> }
>>>>> .memItemRight {
>>>>> padding: 1px 8px 0px 8px;
>>>>> margin: 4px;
>>>>> border-top-width: 1px;
>>>>> border-right-width: 1px;
>>>>> border-bottom-width: 1px;
>>>>> border-left-width: 1px;
>>>>> border-top-color: #E0E0E0;
>>>>> border-right-color: #E0E0E0;
>>>>> border-bottom-color: #E0E0E0;
>>>>> border-left-color: #E0E0E0;
>>>>> border-top-style: solid;
>>>>> border-right-style: none;
>>>>> border-bottom-style: none;
>>>>> border-left-style: none;
>>>>> background-color: #FAFAFA;
>>>>> font-size: 80%;
>>>>> }
>>>>> .memTemplItemLeft {
>>>>> padding: 1px 0px 0px 8px;
>>>>> margin: 4px;
>>>>> border-top-width: 1px;
>>>>> border-right-width: 1px;
>>>>> border-bottom-width: 1px;
>>>>> border-left-width: 1px;
>>>>> border-top-color: #E0E0E0;
>>>>> border-right-color: #E0E0E0;
>>>>> border-bottom-color: #E0E0E0;
>>>>> border-left-color: #E0E0E0;
>>>>> border-top-style: none;
>>>>> border-right-style: none;
>>>>> border-bottom-style: none;
>>>>> border-left-style: none;
>>>>> background-color: #FAFAFA;
>>>>> font-size: 80%;
>>>>> }
>>>>> .memTemplItemRight {
>>>>> padding: 1px 8px 0px 8px;
>>>>> margin: 4px;
>>>>> border-top-width: 1px;
>>>>> border-right-width: 1px;
>>>>> border-bottom-width: 1px;
>>>>> border-left-width: 1px;
>>>>> border-top-color: #E0E0E0;
>>>>> border-right-color: #E0E0E0;
>>>>> border-bottom-color: #E0E0E0;
>>>>> border-left-color: #E0E0E0;
>>>>> border-top-style: none;
>>>>> border-right-style: none;
>>>>> border-bottom-style: none;
>>>>> border-left-style: none;
>>>>> background-color: #FAFAFA;
>>>>> font-size: 80%;
>>>>> }
>>>>> .memTemplParams {
>>>>> padding: 1px 0px 0px 8px;
>>>>> margin: 4px;
>>>>> border-top-width: 1px;
>>>>> border-right-width: 1px;
>>>>> border-bottom-width: 1px;
>>>>> border-left-width: 1px;
>>>>> border-top-color: #E0E0E0;
>>>>> border-right-color: #E0E0E0;
>>>>> border-bottom-color: #E0E0E0;
>>>>> border-left-color: #E0E0E0;
>>>>> border-top-style: solid;
>>>>> border-right-style: none;
>>>>> border-bottom-style: none;
>>>>> border-left-style: none;
>>>>> color: #606060;
>>>>> background-color: #FAFAFA;
>>>>> font-size: 80%;
>>>>> }
>>>>> .search { color: #003399;
>>>>> font-weight: bold;
>>>>> }
>>>>> FORM.search {
>>>>> margin-bottom: 0px;
>>>>> margin-top: 0px;
>>>>> }
>>>>> INPUT.search { font-size: 75%;
>>>>> color: #000080;
>>>>> font-weight: normal;
>>>>> background-color: #e8eef2;
>>>>> }
>>>>> TD.tiny { font-size: 75%;
>>>>> }
>>>>> a {
>>>>> color: #1A41A8;
>>>>> }
>>>>> a:visited {
>>>>> color: #2A3798;
>>>>> }
>>>>> .dirtab { padding: 4px;
>>>>> border-collapse: collapse;
>>>>> border: 1px solid #84b0c7;
>>>>> }
>>>>> TH.dirtab { background: #e8eef2;
>>>>> font-weight: bold;
>>>>> }
>>>>> HR { height: 1px;
>>>>> border: none;
>>>>> border-top: 1px solid black;
>>>>> }
>>>>>
>>>>> /* Style for detailed member documentation */
>>>>> .memtemplate {
>>>>> font-size: 80%;
>>>>> color: #606060;
>>>>> font-weight: normal;
>>>>> }
>>>>> .memnav {
>>>>> background-color: #e8eef2;
>>>>> border: 1px solid #84b0c7;
>>>>> text-align: center;
>>>>> margin: 2px;
>>>>> margin-right: 15px;
>>>>> padding: 2px;
>>>>> }
>>>>> .memitem {
>>>>> padding: 4px;
>>>>> background-color: #eef3f5;
>>>>> border-width: 1px;
>>>>> border-style: solid;
>>>>> border-color: #dedeee;
>>>>> -moz-border-radius: 8px 8px 8px 8px;
>>>>> }
>>>>> .memname {
>>>>> white-space: nowrap;
>>>>> font-weight: bold;
>>>>> }
>>>>> .memdoc{
>>>>> padding-left: 10px;
>>>>> }
>>>>> .memproto {
>>>>> background-color: #d5e1e8;
>>>>> width: 100%;
>>>>> border-width: 1px;
>>>>> border-style: solid;
>>>>> border-color: #84b0c7;
>>>>> font-weight: bold;
>>>>> -moz-border-radius: 8px 8px 8px 8px;
>>>>> }
>>>>> .paramkey {
>>>>> text-align: right;
>>>>> }
>>>>> .paramtype {
>>>>> white-space: nowrap;
>>>>> }
>>>>> .paramname {
>>>>> color: #602020;
>>>>> font-style: italic;
>>>>> white-space: nowrap;
>>>>> }
>>>>> /* End Styling for detailed member documentation */
>>>>>
>>>>> /* for the tree view */
>>>>> .ftvtree {
>>>>> font-family: sans-serif;
>>>>> margin:0.5em;
>>>>> }
>>>>> .directory { font-size: 9pt; font-weight: bold; }
>>>>> .directory h3 { margin: 0px; margin-top: 1em; font-size: 11pt; }
>>>>> .directory > h3 { margin-top: 0; }
>>>>> .directory p { margin: 0px; white-space: nowrap; }
>>>>> .directory div { display: none; margin: 0px; }
>>>>> .directory img { vertical-align: -30%; }
>>>>>
>>>>>
>>>>> _____________________________________
>>>>> Powered by www.kitware.com
>>>>>
>>>>> Visit other Kitware open-source projects at
>>>>> http://www.kitware.com/opensource/opensource.html
>>>>>
>>>>> Please keep messages on-topic and check the ITK FAQ at:
>>>>> http://www.itk.org/Wiki/ITK_FAQ
>>>>>
>>>>> Follow this link to subscribe/unsubscribe:
>>>>> http://www.itk.org/mailman/listinfo/insight-users
>>>>>
>>>> _____________________________________
>>>> Powered by www.kitware.com
>>>>
>>>> Visit other Kitware open-source projects at
>>>> http://www.kitware.com/opensource/opensource.html
>>>>
>>>> Please keep messages on-topic and check the ITK FAQ at:
>>>> http://www.itk.org/Wiki/ITK_FAQ
>>>>
>>>> Follow this link to subscribe/unsubscribe:
>>>> http://www.itk.org/mailman/listinfo/insight-users
>>>
>>> _____________________________________
>>> Powered by www.kitware.com
>>>
>>> Visit other Kitware open-source projects at
>>> http://www.kitware.com/opensource/opensource.html
>>>
>>> Please keep messages on-topic and check the ITK FAQ at:
>>> http://www.itk.org/Wiki/ITK_FAQ
>>>
>>> Follow this link to subscribe/unsubscribe:
>>> http://www.itk.org/mailman/listinfo/insight-users
>>>
>>>
>> _____________________________________
>> Powered by www.kitware.com
>>
>> Visit other Kitware open-source projects at
>> http://www.kitware.com/opensource/opensource.html
>>
>> Please keep messages on-topic and check the ITK FAQ at:
>> http://www.itk.org/Wiki/ITK_FAQ
>>
>> Follow this link to subscribe/unsubscribe:
>> http://www.itk.org/mailman/listinfo/insight-users
>
> --
> Dipl.-Ing. Matthias Keil
> Research Assistant 'Cognitive Computing & Medical Imaging'
>
> Fraunhofer-Institut für Graphische Datenverarbeitung IGD
> Fraunhoferstr. 5 | 64283 Darmstadt | Germany
> Tel +49 6151 155-212 | Fax +49 6151 155-480
> matthias.keil at igd.fraunhofer.de | www.igd.fraunhofer.de
>
More information about the Insight-users
mailing list