DocumentationToCreate

Things that should be explicitly documented.

**Labels:**Phase-Support

Introduction

In preparation for first September 2008 Calagator code sprint, here are some ideas about things to be documented.

Contents

• User Documentation
• Blogger and Calendar Maintainer Documentation
• Coder Documentation

Note: The Google Wiki does not automatically generate a table of contents; so if you add a section below, please add an appropriate entry to the Contents above.

User Documentation

Possibly doing each of these as short wiki pages or wiki page sections that could also serve as Help in context linked from Calagator

Add to Calagator Boomarklet

• How to install
• How to use

Filter by date

• which events will appear

Event dates

• Effect of selecting dates

Event creation

• Suggestions (e.g., include organization acronym in event title; instead of "August Meeting" do "PDXPHP August Meeting")

Venue creation

• Conventions
• Suggestions
• Geocoding

Adding Calagor events to your calendar

• Page of events
• Feed of events

Bug reporting

Suggestions for enhancement

Blogger and Calendar Maintainer Documentation

How to feed your events to Calagator

• Putting events / venues into hCalendar microformat
• Conventions
• Adding your feed to Calagator

Coder Documentation

• Software to Install. See DevelopmentSoftware
• Geocoding instructions. See GeocodingAndMapping
• Coding format conventions. See Index#Coding
• links to external documentation See Index#Documentation

CONTENT UPDATES NEEDED