[[PageOutline]]

= ZMSLabs Howto =

''(still in progress)''

----

== Recommended Proposal Layout ==
 1. '''Who?''' Document Identification / Contact of proposer 
 1. '''Why?''' Background / Overview / Problems 
 1. '''What?''' Objectives / Benefit Statement / Motivation
 1. '''How?''' Scope / Proposed Solution / Deliverables
 1. '''Caveats?''' Assumptions and constraints / Risk Factors
 1. '''Funding?''' Estimates / Costs
 1. '''Status?''' Participants / Actions / Progress

----

== Recommended Mapping to Agilo for Scrum Tickets ==

 * create a new ticket as a '''[/newticket?type=requirement Requirement]'''
   * to record a needed '''Feature'''
   * by describing the '''Why/What?''' ([/agilo-help/scrum/Requirement more...])
   * assign a {{{Milestone}}} (planned release)
   * define the {{{Business Value Points}}} (expected satisfaction by the ''product owner'')
 * create linked ticket(s) to a Requirement as '''[/newticket?type=story User Stories]'''
   * to record suggested '''Approaches'''
   * by describing the '''How/Caveats?''' ([/agilo-help/scrum/UserStory more...]) 
   * assign a {{{Sprint}}} (planned iteration)
   * define {{{Importance}}} (impact and priority)
 * plan a '''Sprint''' ([/agilo-help/scrum/Sprint more...]) for a Milestone (planned release) in the '''[/roadmap Roadmap]'''
   * confirm commitment to a certain amount of User Stories
   * to successfully implement, test, document and integrate during this sprint/iteration
   * define the {{{User Story Points}}} (estimated effort by the ''development team'')
 * create linked ticket(s) to a User Story as '''[/newticket?type=task Tasks]'''
   * to record development '''Jobs'''
   * by describing the '''Actions''' to do ([/agilo-help/scrum/Task more...])
   * set a concerned {{{Component}}}
   * define the {{{Remaining Time}}} and the involved {{{Resources}}}
 * create a new ticket while research and development as '''[/newticket?type=bug Bug]'''
   * to record a '''Defect'''
   * by describing a '''Problem''' with a deployed release
   * set a concerned {{{Component}}}
   * assign a {{{Milestone}}} (the according release)
   * assign a {{{Sprint}}} (to add it to an planned sprint/iteration)

----

== Recommended Versioning for distribution ==

=== Release ===
Significant updates which introduce new features and offer dramatic overall improvement, e.g.
 * ZMSMediaPlayer-v'''3'''.0.0 (increase '''master''')
 * ZMSForum-v1.'''1'''.0 (increase '''major''')

=== Hotfix ===
More frequent updates which include small changes, bug fixes, security updates and quality improvements, e.g.
 * ZMSMediaPlayer-v3.0.'''1''' (increase '''minor''')
 * ZMSForum-v1.1.'''1'''

=== Development ===
Stage of development which are subject to change without public notice, e.g.
 * ZMSMediaPlayer-v3.0.1.'''200905292240''' (add '''datetime''')
 * ZMSForum-v1.1.0.'''354''' (add '''svn-revision''')

----

== Howto use ZMSLabs with Eclipse ==

=== Prepare Eclipse ===

 * download and install Java [http://java.sun.com] 
 * download and unpack/install Eclipse (e.g. Classic Edition) [http://www.eclipse.org/downloads] 
 * download and install Eclipse-Plugins
   * Eclipse-menu "Help" -> "Install new Software" 
   * Option "Search for new features to install"
   * "Add" a new remote site
     * Subclipse [http://subclipse.tigris.org/update_1.6.x]
     * Pydev [http://pydev.org/updates]
     * (Web Tools Platform - WTP (for XML-editing) [http://download.eclipse.org/webtools/updates/])

=== Add Repositories ===
 * Eclipse-menu "Window" -> "Show View" -> "Other"
 * in View-menu select "SVN" -> "SVN Repositories"
 * in "SVN Repositories"-View open context menu and select "New" -> "Repository Location"
 * set "Url" to http://zmslabs.org/svn/zmslabs/ZMS and click "Finish"

=== Checkout Project ===
 * go to folder in "SVN Repositories"-View (e.g. /trunk or /branches/jquery-ui-develop)
 * folder context-menu -> Checkout...

=== Work with local copy of Project ===
 * use PyDev-View (Package Explorer)
 * display history of project: context-menu -> Team -> Show History
 * get latest changes from SVN: context-menu -> Team -> Update
 * commit local changes to SVN: context-menu -> Team -> Commit...

[[Image(zmslabs_svn.png, 450px)]]

=== Add file associations ===
 * open preferences (Eclipse-menu "Window" -> "Preferences")
 * at "General" -> "Editors" -> "File Associations" add file-type *.dtml
 * select the dtml-file-type and add an associated editor (e.g. XML-Editor)

[[Image(file_associations.png, 450px)]]

=== Set svn:ignore ===
 * show navigator-view (Eclipse-menu "Window" -> "Show View" -> "Navigator")
 * open context-menu at file which should be ignored
 * "Team" -> "Add to svn:ignore"
OR
 * open preferences (Eclipse-menu "Window" -> "Preferences")
 * at "Team" -> "Ignored Resources" add pattern (e.g. *.project, *.pydevproject, *.pyc)