Appion

h1. AMI Redmine Quick Start Guide

{{>toc}}

AMI is using "Redmine":http://www.redmine.org for tracking product issues. There are 3 projects available: AMI Group, Appion and Leginon. AMI Group is only available to users that are AMI Lab members. It holds anything that is not specifically related to Appion or Leginon or is not intended for public view. Although there is not a clear division in the software code between Appion and Leginon, we use these as project names to be consistent with how the products are presented to the rest of the world. Leginon is loosely everything that has to do with image capture and Appion relates to image processing. The single svn repository holding the code for both products is available from both Redmine projects.

h2. 1. Register as a user

If you have not registered, click on the "Register" link in the top right corner of the website. After submitting the information requested, an existing Redmine administrator will be notified via email that your registration is pending approval. When you are approved, Sign in using the "Sign in" link at the top right corner of the website.

h2. 2. Select a project to view

Select "Projects" from the top left corner of the website. You will see projects that you are a member of, as well as those that are public.

h2. 3. Add a new issue

* Go to the project that you want to add the issue under. Select the "New issue" tab.

* Select a Tracker: Bug, Feature, Support, or Task.

* Write a descriptive subject line.

* At this point you may select "Create" at the bottom of the page. If you can fill in more information, please do.

* To link to another issue maintained in Redmine, type # followed by the issue number (#17). 

* To link to a subversion changeset, put a lower case r in front of the revision number (r234).

h2. 4. View issues

* Select the "Projects" link at the top left corner of the web page. 

* Select "View all issues" on the right side of the page. This will display all open issues from all projects. 

* At the top of the screen is a "Filters" section.

* Select any combination of filter criteria and click "Apply" to view the results.

* You may save this query and run it in the future. It will show up under "Custom queries" on the right side navigation bar.

h2. 5. Edit a wiki page

To edit, click the "Edit" link at the top of the page. 

Find syntax help "here":http://www.redmine.org/wiki/redmine/RedmineTextFormatting and "here":http://redcloth.org/hobix.com/textile/.

For tips and tricks that were a bit more difficult to find info on check [[Wiki Tips]].

h2. 6. Create a new wiki page

To create a new wiki page, edit an existing one and include double brackets around the name of the page that you wish to create like this:

![[My new wiki page]]

It will appear as a red link when it is saved. 

Click on the link and add content to your new page. 

Remember to save it before navigating away or you will lose all your hard work!

More information on Wiki creation is "here":http://www.redmine.org/wiki/redmine/RedmineWikis.

h2. 7. Add "breadcrumbs" to your wiki page

Breadcrumbs are links that appear at the top of a wiki page that show the previous pages that you visited. 

To add breadcrumbs you must set up parent/child relationships for wiki pages. 

To set the parent of the page that you are currently viewing, select "Rename" at the top right. 

Copy and paste the name of the parent page from the desired parent page's "Rename" section.

h2. 8. Add a Table of Contents to your wiki page

If your wiki page is long with multiple headings, you may want a table of contents.

{{toc}} adds it to the left hand side of your page.

{{>toc}} adds it to the right hand side.