Full Oxid documentation in apple docset format, to use with Dash
After downloading the docset from this repo, open Dash and open the preferences. If you see the preferences window, go to the docset tab and click on + at the left bottom of the enable tab and navigate to the downloaded docset file. Thats it, now you can browse the documentation of OXID.
It almost the same as importing from local, but you have to use the + button at the download tab and paste https://raw.github.com/newLoki/Oxid-Docset/master/Oxid.xml into it. The benefit is that you only have to click at the reload button to get the newest docset.
Actuall this is only a test, so it is a old version of OXID, because i didn't have a newer one locally.
Dash is a realy cool tool, it have so many documentations delivered, but where it goes to the max is, when you can browse the full documentation, and even search throw it. That's impossible, false, it is possible, you can use your own docsets with Dash.
All you need is Doxygen, which can parse your project documentation. Download it, start it and go to the HTML Preferences in List, which have a entry GENERATE_DOCSET, only availeable in expert mode, and some related configuration options which can be set to generate the makefile for generating the docset. Don't forgett to set all other option, like output directory, project name, etc. Now you can run Doxygen by clicking the Run doxygen button under the run tab. After doxygen is finished, you can got to the output folder and call the Makefile in the html subfolder. This takes a little time and afterward you have a docset inside the html folder, which you can import into Dash. Thats it, now you can have so much fun with your project documentation, even if you are not connected, e.g.: on a long trip ;)
Dash can use a xml feed wich have urls to the newest docset files. It will be cool to have a jenkins, which generates a actual docset with each build and a actuallize the feed.xml, so taht you can update your documentation in Dash by a single click. But yet i doesn't get the feed.xml to work with Dash, if you figured out, how it work's, you can tell me ;)
Download basic configuration
curl https://raw.github.com/newLoki/Oxid-Docset/master/DOXYGEN_CONFIG -o ${WORKSPACE}/DOXYGEN_CONFIG
Exporting all needed VARS
export project.logo.path=/path/to/logo.png export docset.publisher.id=newLoki export docset.publisher.name=newLoki
Perl Call for replacing all template vars (${varname}) by his pendant in ENV
perl -p -i -e 's/\$\{([^}]+)\}/defined $ENV{$1} ? $ENV{$1} : $&/eg' template.txt
Generate documentation with doxygen in CLI
doxygen <CONFIG_FILE>
###Put all together
- Buildstep will be (as shell):
curl -O "${WORKSPACE}/DOXYGEN_CONFIG" https://raw.github.com/newLoki/Oxid-Docset/master/DOXYGEN_CONFIG export PROJECT_LOGO_PATH=/path/to/logo.png export DOCSET_PUBLISHER_ID=newLoki export DOCSET_PUBLISHER_NAME=newLoki perl -p -i -e 's/\$\{([^}]+)\}/defined $ENV{$1} ? $ENV{$1} : $&/eg' "${WORKSPACE}"/DOXYGEN_CONFIG doxygen "${WORKSPACE}"/DOXYGEN_CONFIG cd "${WORKSPACE}"/temp_docs/html make
- generate feed.xml
- copy