(→Meego doc) |
|||
| (One intermediate revision not shown) | |||
| Line 1: | Line 1: | ||
| - | + | =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]). | 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]). | ||
| - | + | ==Settings== | |
To administer MeeGo docs, from admin menu go to *@Content management > API Reference settings@* . | To administer MeeGo docs, from admin menu go to *@Content management > API Reference settings@* . | ||
| - | + | ===Default page=== | |
When user types path "developer.meego.com/api" Drupal should redirect user to default page. Usually this page is *main.html* . | When user types path "developer.meego.com/api" Drupal should redirect user to default page. Usually this page is *main.html* . | ||
| - | + | ===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" | 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" | ||
| - | + | ===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". | 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". | ||
| - | + | ===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". | 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". | ||
| - | + | ==Example usage== | |
<pre>drush meego-rescan sites/default/files/apidocs/xml/categories/toc.xml | <pre>drush meego-rescan sites/default/files/apidocs/xml/categories/toc.xml | ||
Contents |
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]).
To administer MeeGo docs, from admin menu go to *@Content management > API Reference settings@* .
When user types path "developer.meego.com/api" Drupal should redirect user to default page. Usually this page is *main.html* .
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"
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".
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".
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 ...