Tutorial

From Cyclopath

This page is the in-process tutorial for Cyclopath.

Contents 1 Ideas 1.1 Difference between the tutorial and the user manual 1.2 Content 1.3 Content Type 2 The Tutorial 2.1 Sections 2.2 Getting Around 2.3 Rating and Route Finding 2.4 Editing the Map 2.5 Revisions 2.6 Watch Regions 2.7 Common Pitfalls

[edit] Ideas

Here are a few ideas:

[edit] Difference between the tutorial and the user manual

The user manual is an in-depth collection of information about Cyclopath. The tutorial, on the other hand, should be basic and targeted towards new users that are not yet familiar with the system.

[edit] Content

The tutorial should only cover the basics of interacting with Cyclopath, such as getting around, finding routes, and editing. Some proposed sections are outlined below at Tutorial#Sections.

[edit] Content Type

The tutorial should include screenshots so that readers can follow along. Still, there should be a limit on number of screenshots per tutorial section so that it doesn't get too cluttered. For now, we will keep that limit at 5.

[edit] The Tutorial

[edit] Sections

• #Getting Around
• #Rating and Route Finding
• #Editing the Map
• #Revisions
• #Watch Regions
• #Common Pitfalls

[edit] Getting Around

Cyclopath is at its core simply a map. That is why the most obvious thing you will notice when you visit it will be a map of the Twin Cities. Everything revolves around this map. After you have located the map (shouldn’t take you more than a few milliseconds) you can then start focusing on all the other awesome stuff lying around. Here’s an overview of some of the stuff you’ll find (labeled on the picture below for your convenience):

1. • Help Button – If you get stuck, this is the place to go! This opens a new window with help information.
   • Log in/ Register Button – You can use Cyclopath even if you’re not registered, but that’s no fun. Please register!
2. Item Details Panel – This panel displays information about blocks (as in road segments) and points (as in locations of interest). It remains empty until you select a block or point.
3. We’ll talk about these other panels in later tutorials. For now, just take our word that they’re very useful!
4. The map, just in case you couldn’t find it.
5. Navigation – You can move around the map by either dragging it or using the navigation buttons here on the upper left. The plus and minus buttons are for zooming in and out, respectively. You can also go to a specific location by using the "Go To" button.
6. Editing tools – Since this is a geowiki, it means that you can edit the map. That’s right. You can change information, points, and even the road segments themselves as you see necessary (try not to vandalize though). The set of tools on the upper right are used for editing, but we’ll delay the explanation of these tools for another tutorial. For now, all we need is the select tool.
7. More Tools – These are a few settings and tools. You can save any of your changes here. The four checkboxes toggle connectivity (which shows you which blocks are connected to which blocks), Watch Regions (we’ll talk about this later), Aerial Photos (so you can see what the map really looks like), and Sticky Intersections (we’ll talk about this later too).
8. Map Key – If you forget what some of the colors and shapes mean, just click on the map key for a refresher.

Viewing Item Details

When you are zoomed close enough, you can click on points and blocks to view their details. The screenshot below shows what that looks like.

1. A selected block – When you select a block, it is highlighted with blue and all its vertices are shown. Its information is then shown on the left.
2. Points are in the shape of circles. They too can be selected to display their information.
3. Name - The name of the block or point, which usually shows on the map.
4. Type – For blocks, you can select the road type.
5. Flags – Some more options to set for blocks.
6. Ratings – We’ll talk about this more in the next part of the tutorial, but basically this is where you rate blocks.
7. All blocks and points can have notes associated with them. This is where you can see and edit these notes. Blocks that have notes appear on the map highlighted with purple.

If you’re a new user, then you probably aren’t interested or confident enough to start editing right away. Take some time to explore the map, clicking on different byways and points to see their information.

[edit] Rating and Route Finding

This section should introduce users to rating blocks and finding routes (both of which have no effect on other users).

[edit] Editing the Map

This section should talk about how to edit the map.

[edit] Revisions

This section should talk about revisions in Cyclopath and probably also revisions in general (what they are, how to look at changes, what reverting is, etc.)

[edit] Watch Regions

How to keep track of changes with watch regions.

[edit] Common Pitfalls

Common errors made by users.