Revision as of 13:19, 28 March 2011 (view source) Quang (Talk | contribs) ← Older edit		Latest revision as of 11:57, 29 March 2011 (view source) Quang (Talk | contribs) (→Meego doc)
(10 intermediate revisions not shown)
Line 1:		Line 1:
-	== Introduction ==	+	=Meego doc=
-	=== Design Overview ===	+
-	=== Team and developers ===	+
-	Current team:	+	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]).
-	* Teemu Lukkari (production manager)	+
-	* Graham Honeywill (account manager)	+
-	* Quang Pham (drupal developer)	+
-	* Mika Matikainen (concept designer, graphic designer)	+
-	* Ronan MacLaverty (product owner from Nokia)	+
-	* Michael R. Shaverty (Drupal developer and hosting provider from Intel)	+
-	Other persons involved before:	+	==Settings==
-	* Mikael Kundert (drupal developer)	+
-	* Andrew Burcin (drupal developer)	+
-	* Jakub Suchy (drupal developer, API docs)	+
-	=== Project managing tools ===	+
-	=== Environment overview ===	+
-	== Design Overview ==	+
-	== System architectural design ==	+	To administer MeeGo docs, from admin menu go to *@Content management > API Reference settings@* .
-	== Detail description of modules (patching / update) ==	+	===Default page===
-	== Detail description of content structure ==	+	When user types path "developer.meego.com/api" Drupal should redirect user to default page. Usually this page is *main.html* .
-	== Backup solution ==	+	===Data path===
-	== Additional Materials ==	+	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".
		+
		+	===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".
		+
		+	==Example usage==
		+
		+	<pre>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
		+	...</pre>

---

Latest revision as of 11:57, 29 March 2011

Contents 1 Meego doc 1.1 Settings 1.1.1 Default page 1.1.2 Data path 1.1.3 Attribute name for title 1.1.4 Attribute name for URL 1.2 Example usage

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]).

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* .

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"

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".

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".

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
...