Documentation/Maemo Documentation Guidelines/Maemo document structure - Revision history

amigadave: /* Maemo document structure */ wikify slightly

amigadave — Thu, 15 Jul 2010 07:48:25 GMT

Maemo document structure: wikify slightly

← Older revision		Revision as of 07:48, 15 July 2010
Line 1:		Line 1:
-	~~= Maemo document structure =~~
-
	A typical Maemo document has the following structure:		A typical Maemo document has the following structure:

Line 41:		Line 39:
	: must have title, publishing date and references to both Nokia Corporation and maemo.org. Cover page will not be included to the table of contents.		: must have title, publishing date and references to both Nokia Corporation and maemo.org. Cover page will not be included to the table of contents.
	; '''Preface'''		; '''Preface'''
-	: must be based on ~~tempates~~ available as appendixes for this ''Maemo Documentation Guidelines'' document. Base license must be [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License, version 1.2] and if document includes code examples copyrighted by Nokia they must use MIT-style license. Preface will not be included to the table of contents.	+	: must be based on templates available as appendixes for this ''Maemo Documentation Guidelines'' document. Base license must be [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License, version 1.2] and if document includes code examples copyrighted by Nokia they must use MIT-style license. Preface will not be included to the table of contents.
	; '''List of Figures and Tables'''		; '''List of Figures and Tables'''
	: chapters are optional, for PDF documents only and will not be included to the table of contents.		: chapters are optional, for PDF documents only and will not be included to the table of contents.
Line 56:		Line 54:
	; '''Appendix'''		; '''Appendix'''
	: chapters are optional. Each appendix must start from new page.		: chapters are optional. Each appendix must start from new page.
-
-
-
-	~~----~~

	[[Category:Documentation]]		[[Category:Documentation]]

amigadave: categorize

amigadave — Mon, 10 May 2010 11:57:48 GMT

categorize

← Older revision		Revision as of 11:57, 10 May 2010
Line 60:		Line 60:

	----		----
		+
		+	[[Category:Documentation]]

dneary: 1 revision

dneary — Fri, 09 Apr 2010 13:34:56 GMT

1 revision

← Older revision

Revision as of 13:34, 9 April 2010

Wikiuser: importing documentation, see Meta:Problems in the LaTeX2HTML2Wiki import process

Wikiuser — Fri, 09 Apr 2010 08:48:14 GMT

importing documentation, see Meta:Problems in the LaTeX2HTML2Wiki import process

New page

= Maemo document structure =

A typical Maemo document has the following structure:

'''Cover page'''
'''Preface'''
'''Table of Contents'''
'''List of Figures'''
'''List of Tables'''
'''Glossary'''
'''Chapter Introduction'''
- introduction to the whole document
'''Chapter AAAAAA'''
'''Section Introduction'''
- introduction to the chapter
- links to example applications
- links to API documents
'''Section BBBBBB'''
'''SubSection bbbbbb'''
'''SubSubSection dddddd'''
'''Paragraph pppppp'''
'''Section CCCCCC'''
'''Section Summary'''
- summary of the chapter
- links for further reading
'''Chapter XXXXXX'''
'''Section Introduction'''
- introduction to the chapter
- links to example applications
- links to API documents
'''Section YYYYYY'''
'''Section Summary'''
- summary of the chapter
- links for further reading
'''Bibliography'''
'''Appendix'''

The document structure given below assumes that each document chapter (except '''Introduction''' chapter for the whole document) is independent from other chapters and can be reused also for other documents, if needed.

; '''Cover page'''
: must have title, publishing date and references to both Nokia Corporation and maemo.org. Cover page will not be included to the table of contents.
; '''Preface'''
: must be based on tempates available as appendixes for this ''Maemo Documentation Guidelines'' document. Base license must be [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License, version 1.2] and if document includes code examples copyrighted by Nokia they must use MIT-style license. Preface will not be included to the table of contents.
; '''List of Figures and Tables'''
: chapters are optional, for PDF documents only and will not be included to the table of contents.
; '''Glossary'''
: chapter is optional and will not be included to the table of contents.
; '''Introduction'''
: chapter for the whole document and sections for each chapter are mandatory and they do not have Subsections. Introduction section for each chapter must include links to supporting example applications and API documents used in that chapter.
; '''Chapter'''
: always starts from a new page and is independent from other chapters. Chapters can have four different level sections in their internal structure.
; '''Summary'''
: section for each chapter is optional but if used, should give reader links for further reading.
; '''Bibliography'''
: chapter is optional.
; '''Appendix'''
: chapters are optional. Each appendix must start from new page.

----