Editing Documentation/Maemo Documentation Guidelines/Maemo document structure

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

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

----

[[Category:Documentation]]

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Retrieved from "http://wiki.maemo.org/Documentation/Maemo_Documentation_Guidelines/Maemo_document_structure"

Personal tools

Navigation

Views

Editing Documentation/Maemo Documentation Guidelines/Maemo document structure

@@ Line 1: / Line 1: @@
+= Maemo document structure =
 A typical Maemo document has the following structure:
@@ Line 39: / Line 41: @@
 : 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 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.
+: 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.
@@ Line 54: / Line 56: @@
 ; '''Appendix'''
 : chapters are optional. Each appendix must start from new page.
+----
 [[Category:Documentation]]