Skip to main content

Wiki

The Wiki is a set of pages for the knowledge that sits behind your maps: procedures, field notes, contacts, decisions, and the history of your data. It belongs to the whole organization.

Pages can link to the maps, layers, and features they describe, and a page can be shown as a guide on a layer's features, so a procedure is one tap away for whoever opens the feature.

Open it from Wiki in the left sidebar.

Who can read and edit​

RoleWiki access
Owner, Admin, Org EditorRead, create, edit, move, and delete pages; add and manage guides
MemberRead every page, and see the guides on features they can open

Every member of the organization can read every Wiki page, whatever groups they belong to. Don't put information on a Wiki page that some members shouldn't see.

The Wiki is never included on shared or public maps.

Using the Wiki​

Finding your way around​

Pages are listed on the left. A page can have subpages under it, so you can group related pages, for example a Pump stations page with one subpage per station. Click the arrow next to a page to show or hide its subpages.

The path above a page's title shows where it sits. Click any part of the path to go to that page.

Opening the Wiki takes you to the first page in the list, so that page works well as a home or index page.

Searching​

Type in Search the Wiki above the page list. Results update as you type and show every page whose title or text contains all of your words, best matches first, with the matching words highlighted. Words match their beginnings and related forms, so insp finds "inspection" and "inspected".

Press Esc or click the × to go back to the page list.

Creating a page​

  1. Click New page above the page list, or open a page's ⋮ menu and choose Add subpage.
  2. Enter a title.
  3. Under Start from, keep Blank page or choose a template.
  4. Click Create page. The new page opens in the editor so you can start writing.

Templates​

The Wiki comes with templates for an Asset procedure, a Field inspection, Meeting notes, and a Decision record.

To add your organization's own templates, create a top-level page named Templates and write each template as a subpage of it. They appear under Your organization's templates when anyone creates a page. Editing a template never changes pages already made from it.

Editing a page​

Click Edit at the top of a page. Change the title or the text, then click Save (or press Ctrl+S, Cmd+S on a Mac).

Pages are written in Markdown, a simple way to format text with ordinary characters. You don't need to learn it first: the toolbar above the text adds the formatting for you, and the preview next to the text shows how the page will look. On a phone, switch between Write and Preview with the tabs above the text.

You typeYou get
## HeadingA section heading
**bold**bold
_italic_italic
- itemA bulleted list
1. itemA numbered list
- [ ] taskA checklist item
[text](https://example.com)A link
> quoteA quote

Tables are supported too. Use Markdown help in the toolbar for the full reference.

Adding images​

Add a photo, diagram, or screenshot in any of these ways:

  • Paste it into the text (for example a screenshot copied to your clipboard).
  • Drag image files onto the text.
  • Click the image button in the toolbar and choose one or more files.

JPEG, PNG, WebP, and HEIC images up to 20 MB are supported. While an image uploads, the text shows Uploading… where it will appear. Wait for uploads to finish before saving.

Images are resized to at most 2048 pixels on their longest side. Location and camera details stored inside photos are removed, so a page never reveals where a photo was taken. Wiki images count toward your organization's storage, the same as attachments.

If someone else saves first​

If another person saves the same page while you are editing it, your save is stopped so that neither of you overwrites the other. You'll see a message with two buttons:

  1. Click Copy my text to copy what you wrote.
  2. Click Load latest version to open the page as it is now.
  3. Add your changes again, then save.

Page history​

Every time a page is saved, the previous version is kept. Click History at the top of a page to see them all, newest first, with who saved each one and when.

Select a version, then:

  • Changes shows what that version changed compared with the one before it. Added lines are green, removed lines are red, and long stretches that didn't change are folded away.
  • Page shows the page as it looked in that version.

Owners, admins, and org editors can click Restore version to bring an older version back. It's saved as a new version, so the version you replaced stays in the history too.

Organizing pages​

Open a page's ⋮ menu, in the page list or at the top of the page:

  • Move up and Move down change its position among the pages next to it. On a computer you can also drag a page by its handle to reorder it.
  • Move to… puts it under a different page, or back at the top level. Its subpages move with it.

Deleting a page​

Open the page's ⋮ menu and choose Delete. The page and all of its subpages move to Trash.

If the page or any of its subpages is a guide, the confirmation says on how many layers. While the pages are in Trash, those guides stop showing on features.

To bring them back, go to Data, open Trash at the bottom of the Datasets tab, and click Restore on the page. Its subpages come back with it, and so do their guides. If the page it was under is still there, it returns there; otherwise it returns to the top level.

Owners and admins can delete a page in Trash permanently. This also deletes its subpages, their history, any images no other page uses (which frees that storage), and their guides on every layer. It cannot be undone.

Pages being created, edited, deleted, and restored appear in your organization's Activity. Adding or changing guides does not.

Exporting to Markdown​

Download the Wiki as Markdown files, for a backup or to use in other tools:

  • Click the download button above the page list to export the whole Wiki.
  • Open a page's ⋮ menu and choose Export as Markdown to export that page and its subpages.

You get a zip file with one .md file per page, named after the page title. A page's subpages are in a folder with the same name. Images are in an images folder, and the pages link to them there. Links to maps, layers, and features only work inside the app.

Everyone who can read the Wiki can export it.

Connecting the Wiki to your maps​

There are two ways to connect a page to your data:

  • A link points from a page to one map, layer, or feature. The feature or layer then lists the page under Referenced in Wiki. Use links for notes about one particular thing, like an incident report on a single valve.
  • A guide shows a page on a layer's features, on every feature or only where a value matches. Use guides for how to work on a kind of thing, like the cleanout procedure for every storm drain.

Linking to maps, layers, and features​

While editing a page, click the pin button in the toolbar and choose:

  • Map: pick a map from the list.
  • Layer: pick a layer or data table.
  • Feature: choose the layer, enter the feature's number (the # shown in its attribute panel), click Find, then Insert link.

If you select some text first, it becomes the link's text. Otherwise the link uses the item's name.

You can also start from the map: open a feature's attribute panel and click Copy Wiki link, then paste it into a page. Layers have the same button on their details page under Data. Only owners, admins, and org editors see Copy Wiki link.

On the page, links show as small labels with an icon. Clicking one opens the map (centered on the feature, with its attribute panel open), or the data table for tables and for layers that aren't on a map you can open. While you edit, links in the preview open in a new tab so you don't lose your changes.

Each reader only sees links to what they have access to. A link to something they can't open, or that was deleted, shows as Restricted item and doesn't reveal its name.

Referenced in Wiki​

When a page links to a feature or a layer, that feature's attribute panel and that layer's details page list the page under Referenced in Wiki, so you can go from the data back to what has been written about it.

Guides​

A guide puts a Wiki page at the top of a feature's attribute panel on the map, so whoever opens the feature can read how to work on it. Instead of linking a procedure to every feature one at a time, you attach it to a layer once:

  • On every feature in the layer, for example a Storm drain cleanout procedure on every storm drain.
  • Or only on features where a value matches, for example Gas line safety only where Type is Gas, on a layer that holds every kind of utility.

Guides follow the feature's current values. New features get their guides as soon as they're added, and if someone changes a pipe's Type from Gas to Sewage, its guides change with it. While you add or edit a feature, the guides update as you fill in the form, so a collector sees the safety procedure before saving.

Guides only appear on map layers, not data tables, and never on shared or public maps.

Reading a guide​

Open a feature on the map. Its guides are listed under Guides, just below the feature's name in the attribute panel. A guide that only shows on some features says why, for example Where Type equals "Gas". If there are more than three, click +N more.

Click a guide to read it over the map. Close it (or press Esc) to go back to the same feature, or click Open in Wiki to open the full page.

Adding a guide​

Owners, admins, and org editors can add guides from either side:

  • From the layer: open the layer's details page from Data and click + Add guide under Guides. Choose the page.
  • From the page: open the page's ⋮ menu and choose Show as a guide…. Choose the layer.

Then choose where it shows:

  1. Every feature in the layer, or Only features where….
  2. For Only features where…, build the condition the same way as a map filter: pick a field, how to compare, and the value. Add more conditions, or an OR group, if you need them.
  3. Check the line under the condition: it says how many features the guide shows on right now. Shows on no features yet usually means the condition needs a second look.
  4. Click Add guide.

Adding a page that is already a guide on that layer changes where it shows instead of adding it twice.

Managing guides​

On the layer's details page, each guide shows where it applies. Click Edit to change where it shows, Remove to stop showing it (the Wiki page itself is not changed), or the arrows to change the order guides appear in.

Owners, admins, and org editors also see Manage guides under a feature's guides, which takes them to that list. It is hidden while you add or edit a feature, so you never leave an unsaved form.

A Wiki page that is a guide shows Guide on and the layers under its title, so you know who will read your changes.

Two labels on the layer page need your attention:

  • In Trash: the page was moved to Trash. The guide is hidden from features until the page is restored, and comes back by itself when it is.
  • Needs attention: the condition uses a field that was deleted, so the guide shows on no features. Click Edit to fix the condition.