Difference between revisions of "Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0"

From Apache OpenOffice Wiki
Jump to: navigation, search
(removed old template noinclude sections for the benefit of the new standard template header template)
Line 14: Line 14:
 
  &#124;references=<WikiMarkup> // standard wiki markup providing references to internal a/o external resources
 
  &#124;references=<WikiMarkup> // standard wiki markup providing references to internal a/o external resources
 
|parameters=
 
|parameters=
−
'''goals'''
+
* iteration
−
 
+
: The iteration number.
−
unordered list of goals where individual entries are categorized by Documentation, Learning, etc.
+
* release
−
additional sub categories such as Documentation::Process, or Development::Process, or Documentation::HowTo
+
: The release version identifier.
−
can be defined and must be documented in the wiki, the categories are named based on the types of produces
+
* goals
−
being produced by the iteration
+
: TBD unordered list of goals where individual entries are categorized by Documentation, Learning, etc.
−
 
+
: additional sub categories such as Documentation::Process, or Development::Process, or Documentation::HowTo
−
'''Example'''
+
: can be defined and must be documented in the wiki, the categories are named based on the types of produces
−
 
+
: being produced by the iteration
−
'''Preview'''
+
* produces
−
 
+
: TBD unordered list of produces where individual entries are categorized by Wiki, Repository and IssueTracker
−
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
+
: additional categories can be added as required, however, they must be documented in the wiki
−
 
+
: the categories are named based on the storage being used for the individual produces of the iteration
−
TBD preview for goals section
+
* subprojects
−
 
+
: TBD displays a tree of subprojects affected the iteration using an unordered list<br/>
−
'''produces'''
+
: individual items can be laid out as links to individual sub project pages in the<br/>
−
 
+
: wiki, if available a/o desired
−
unordered list of produces where individual entries are categorized by Wiki, Repository and IssueTracker
+
* references
−
additional categories can be added as required, however, they must be documented in the wiki
+
: TBD provides an unordered list of references to either internal a/o external documents and other resources<br/>
−
the categories are named based on the storage being used for the individual produces of the iteration
+
: individual items may be categorized by reference categories, where individual categories must be named<br/>
−
 
+
: by the content type of the resource referenced, e.g. Media, Files, Documents and so on
−
'''Example'''
+
* preview=
−
 
+
: TBD  
−
<pre>
+
−
|produces=
+
−
* Wiki
+
−
** [[WikiProduce1]]
+
−
** [[WikiProduce2]]
+
−
* Repository
+
−
** [[RepositoryProduce1]]
+
−
** [[RepositoryProduce2]]
+
−
* IssueTracker
+
−
** https://.../IssueTrackerProduce1
+
−
** https://.../IssueTrackerProduce2
+
−
</pre>
+
−
 
+
−
'''Preview'''
+
−
 
+
−
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
+
−
 
+
−
* Wiki
+
−
** [[WikiProduce1]]
+
−
** [[WikiProduce2]]
+
−
* Repository
+
−
** [[RepositoryProduce1]]
+
−
** [[RepositoryProduce2]]
+
−
* IssueTracker
+
−
** https://.../IssueTrackerProduce1
+
−
** https://.../IssueTrackerProduce2
+
−
 
+
−
'''subprojects'''
+
−
 
+
−
displays a tree of subprojects affected the iteration using an unordered list<br/>
+
−
individual items can be laid out as links to individual sub project pages in the<br/>
+
−
wiki, if available a/o desired
+
−
 
+
−
'''Example'''
+
−
 
+
−
<pre>
+
−
|subprojects=
+
−
* [[Requirements Analysis]]
+
−
* [[Prototype Development]]
+
−
** [[Architecture and Design]]
+
−
** [[Prototype Implementation]]
+
−
** [[Prototype Maintenance]]
+
−
</pre>
+
−
 
+
−
'''Preview'''
+
−
 
+
−
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
+
−
 
+
−
* [[Requirements Analysis]]
+
−
* Prototype Development
+
−
** [[Prototype Architecture and Design]]
+
−
** [[Prototype Implementation]]
+
−
** [[Prototype Maintenance]]
+
−
 
+
−
'''references'''
+
−
 
+
−
provides an unordered list of references to either internal a/o external documents and other resources<br/>
+
−
individual items may be categorized by reference categories, where individual categories must be named<br/>
+
−
by the content type of the resource referenced, e.g. Media, Files, Documents and so on
+
−
 
+
−
'''Example'''
+
−
 
+
−
<pre>
+
−
|references=
+
−
* Documents
+
−
** [http://foo/bar.html document describing a bar]
+
−
* Media
+
−
** [https://foo/bar_visiting.mov movie on bar visiting]
+
−
* Files
+
−
** [http://foo/bar_draining.java sample source implementing a bar draining algorithm]
+
−
</pre>
+
−
 
+
−
'''Preview'''
+
−
 
+
−
'''IMPORTANT: Please do not create the below linked to dummy pages.'''
+
−
 
+
−
* Documents
+
−
** [http://foo/bar.html document describing a bar]
+
−
* Media
+
−
** [https://foo/bar_visiting.mov movie on bar visiting]
+
−
* Files
+
−
** [http://foo/bar_draining.java sample source implementing a bar draining algorithm]
+
−
|preview=
+
−
TBD include testcase for preview
+
 
}}
 
}}
−
 
 
[[Category:OOPM:Templates:Documentation|Development]]
 
[[Category:OOPM:Templates:Documentation|Development]]
−
 
 
</noinclude>
 
</noinclude>
  

Revision as of 18:48, 8 April 2009


Meta

Template Name Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0
Author Carsten Klein "rts" <carsten.klein@abstraxion.de>
Created 2009-04-07
Edited 2009-004-08

Purpose

TBD Template purpose

Synopsis

{{Templates:OOPM:Templates:Documentation:Development:IterationStatement:1.0
|iteration=<Integral>		// the iteration number
|release=<ReleaseVersion>>	// the release version targetted by the iteration
|goals=<WikiMarkup>		// standard wiki markup formulating the goals for this iteration
|produces=<WikiMarkup>		// standard wiki markup stating the expected produces of the iteration
|subprojects=<WikiMarkup>	// standard wiki markup stating the affected/active subprojects for this iteration
|references=<WikiMarkup>	// standard wiki markup providing references to internal a/o external resources
}}

Parameter Reference

  • iteration
The iteration number.
  • release
The release version identifier.
  • goals
TBD unordered list of goals where individual entries are categorized by Documentation, Learning, etc.
additional sub categories such as Documentation::Process, or Development::Process, or Documentation::HowTo
can be defined and must be documented in the wiki, the categories are named based on the types of produces
being produced by the iteration
  • produces
TBD unordered list of produces where individual entries are categorized by Wiki, Repository and IssueTracker
additional categories can be added as required, however, they must be documented in the wiki
the categories are named based on the storage being used for the individual produces of the iteration
  • subprojects
TBD displays a tree of subprojects affected the iteration using an unordered list
individual items can be laid out as links to individual sub project pages in the
wiki, if available a/o desired
  • references
TBD provides an unordered list of references to either internal a/o external documents and other resources
individual items may be categorized by reference categories, where individual categories must be named
by the content type of the resource referenced, e.g. Media, Files, Documents and so on
  • preview=
TBD


Uses Template:OOPM:Templates:Documentation:Shared:StandardTemplateHeader

Retrieved from "https://wiki.openoffice.org/w/index.php?title=Template:OOPM:Templates:Documentation:Development:ReleaseIterationStatement:1.0&oldid=118913"
Personal tools