Revision as of 11:56, 29 March 2011

Meego doc

MeeGo docs module takes care of importing and holding the API reference pages. It contains a simple drush command which takes one argument (path to table of contents xml [toc]).

h2. Settings

To administer MeeGo docs, from admin menu go to *@Content management > API Reference settings@* .

h3. Default page

When user types path "developer.meego.com/api" Drupal should redirect user to default page. Usually this page is *main.html* .

h3. Data path

Data path contains the HTML files having all the contents which is referred from table of contents XML (toc.xml). Example value "sites/default/files/apidocs/html"

h3. Attribute name for title

Some TOC XML file may have different attribute name for title. This settings allows you to define which attribute name to look for the title. Example value "title".

h3. Attribute name for URL

Some TOC XML file may have different attribute name for URL path to HTML files / contents. This settings allows you to define which attribute name to look for. Example value "href".

h2. Example usage

drush meego-rescan sites/default/files/apidocs/xml/categories/toc.xml

Clearing menu items...
Processed file sites/default/files/apidocs/html/main.html
Processed file sites/default/files/apidocs/html/categories/Application_Frameworks.html
Processed file sites/default/files/apidocs/html/qt4/qtdeclarative.html
Processed file sites/default/files/apidocs/html/qt4/plugins.html
Processed file sites/default/files/apidocs/html/qt4/qdeclarativeextensionplugin.html
Processed file sites/default/files/apidocs/html/qt4/qdeclarativecomponent.html
Processed file sites/default/files/apidocs/html/qt4/qdeclarativecontext.html
...