Getting started¶
Overview¶
The CoMapeo Config Spreadsheet Plugin lets you define categories, fields, icons, colors, and translations in Google Sheets, then export a .comapeocat file for CoMapeo.
Prerequisites¶
- A Google account with access to Google Sheets
- The template spreadsheet: https://docs.google.com/spreadsheets/d/1bvtbSijac5SPz-pBbeLBhKby6eDefwweLEBmjAOZnlk/edit?usp=drivesdk
Sheet map (quick reference)¶
| Sheet | Purpose |
|---|---|
| Categories | Category names, icons, fields, applies, colors |
| Details | Field definitions and options |
| Translation sheets | Optional translations for names, labels, helper text, options |
| Metadata | Config metadata and versioning |
For exact column rules, see the sheet references: Categories, Details, Translation sheets, Metadata.
Step 1: Set your primary language¶
- Open the Categories sheet.
- Click cell A1.
- Enter your primary language name (English or native name).
See Translation sheets for accepted language formats.
Step 2: Add categories¶
- In Categories, starting at row 2, enter category names in column A.
For examples and edge cases, see Categories sheet tasks.
Step 3: Add fields¶
- In Details, starting at row 2, add field names.
- Set type and options as needed.
For field types and options rules, see Details sheet tasks and Details sheet.
Step 4: Link fields to categories¶
- In Categories column C (Fields), list field names for each category.
- Field names must match the Details sheet exactly.
Step 5: Set Applies values (required)¶
- In Categories column D (Applies), set where each category is used.
- Ensure at least one category includes
track.
See Categories sheet for valid values. See Categories sheet tasks for steps.
Step 6: Add icons¶
Paste inline SVG from https://icons.earthdefenderstoolkit.com into Icon (column B).
See Categories sheet tasks for all supported formats.
Step 7: Set category colors¶
Set the background color of each category name cell in column A.
Step 8: Add translations (optional)¶
Use CoMapeo Tools → Manage Languages & Translate to add translation columns.
See Translations and Translation sheets.
Step 9: Run linting¶
Run CoMapeo Tools → Lint Sheets and fix highlighted cells.
See Export and share and Linting rules.
Step 10: Generate the config¶
Open CoMapeo Tools → Generate CoMapeo Category and wait for completion.
See Export and share.
Step 11: Share and import in CoMapeo¶
Share the .comapeocat from Drive and import it in CoMapeo.
See Export and share. If you are updating an existing config, see Import and maintenance.
What to do next¶
- If you need task-specific help, use the How-to guides.
- If you need exact rules and formats, use Reference.
- If something fails, see Troubleshooting.