Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#6715 closed enhancement (fixed)

Add menu tabs to gdal.org site

Reported by: Jeff McKenna Owned by: warmerdam
Priority: normal Milestone: 2.2.0
Component: Docs Version: svn-trunk
Severity: normal Keywords:
Cc:

Description

The following changes will add a few tabs into the top menu of gdal.org For a screenshot see http://pasteboard.co/ndEWlCsFM.png

Please execute the following:

1) apply the attached patch (menu.patch), which modifies GDAL's Doxygen config file

2) add the second attached file (DoxygenLayout.xml) into the GDAL home directory, which is used to setup the menus

3) on whatever server is used to generate the html, it's important that we upgrade the installed Doyxygen version. Ubuntu for example by default uses a much older Doxygen package, and therefore the generated menus don't look properly (they don't display the sub-menus, on mouse-over).

  • check installed Doxygen version (we need 1.8.12):
    doxygen --version
    

  • download 1.8.12
    wget http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.12.src.tar.gz
    
  • install new version
     - tar -xzvf doxygen-1.8.12.src.tar.gz
     - cd doxygen-1.8.12
     - mkdir build
     - cd build
     - cmake -G "Unix Makefiles" ..
     - make
     - sudo cp bin/doxygen /usr/local/bin/
       - (normal 'sudo make install' didn't work for me in this case)
    
  • verify the installed doxygen version
    doxygen --version
    

4) regenerate html

  • inside GDAL home directory, execute:
    doxygen
    

Attachments (3)

menu.patch (553 bytes ) - added by Jeff McKenna 6 years ago.
patch to the Doxygen config file
DoxygenLayout.xml (6.6 KB ) - added by Jeff McKenna 6 years ago.
new layout file (to set menus)
DoxygenLayout.2.xml (6.7 KB ) - added by Jeff McKenna 6 years ago.
Fixed odd issue of "&" in tracker path

Download all attachments as: .zip

Change History (9)

by Jeff McKenna, 6 years ago

Attachment: menu.patch added

patch to the Doxygen config file

by Jeff McKenna, 6 years ago

Attachment: DoxygenLayout.xml added

new layout file (to set menus)

by Jeff McKenna, 6 years ago

Attachment: DoxygenLayout.2.xml added

Fixed odd issue of "&" in tracker path

comment:1 by Jeff McKenna, 6 years ago

Sorry for that. Please download 'menu.patch' and 'DoxygenLayout.2.xml', but rename the second file to 'DoxygenLayout.xml'

comment:2 by Even Rouault, 6 years ago

Resolution: fixed
Status: newclosed

In 36102:

Docs: add menu tabs to Download and Issue tracker (derived from patch by Jeff McKenna, fixes #6715)

comment:3 by Even Rouault, 6 years ago

I've fixed independantly the issue with the link to track. You need to escape & to & I've added in the makefile a test to check that Doxygen >= 1.8 and if not, I strip the customization. I've verified that the doxygenlayout.xml works at least with Doxygen 1.8.6. www.gdal.org that is used for the refreshing cron job has Doxygen 1.8.8

comment:4 by Even Rouault, 6 years ago

I've just manually triggered a manual refresh. http://gdal.org/ looks good.

comment:5 by Even Rouault, 6 years ago

In 36103:

Unbreak man page generation with Doxygen < 1.8 (refs #6715)

comment:6 by Jeff McKenna, 6 years ago

thanks Even!

Note: See TracTickets for help on using tickets.