Edit This Page

Using Page Templates

These page templates are available for writers who would like to contribute new topics to the GeoidApp docs:

• Task
• Tutorial
• Concept

The page templates are in the _includes/templates directory of the GeoidApp.github.io repository.

Task template

A task page shows how to do a single thing, typically by giving a short sequence of steps. Task pages have minimal explanation, but often provide links to conceptual topics that provide related background and knowledge.

To write a new task page, create a Markdown file in a subdirectory of the /docs/tasks directory. In your Markdown file, provide values for these variables, and then include templates/task.md:

• overview - required
• prerequisites - required
• steps - required
• discussion - optional
• whatsnext - optional

Here's an example of a Markdown file that uses the task template:

---
---

{% capture overview %}
This page shows how to ...
{% endcapture %}

{% capture prerequisites %}
* Do this.
* Do this too.
{% endcapture %}

{% capture steps %}
### Doing ...

1. Do this.
1. Do this next. Possibly read this [related explanation](...).
{% endcapture %}

{% capture discussion %}
### Understanding ...

Here's an interesting thing to know about the steps you just did.
{% endcapture %}

{% capture whatsnext %}
* Learn more about [this](...).
* See this [related task](...).
{% endcapture %}

{% include templates/task.md %}

Here's an example of a published topic that uses the task template:

Using an HTTP Proxy to Access the GeoidApp API

Tutorial template

A tutorial page shows how to accomplish a goal that is larger than a single task. Typically a tutorial page has several sections, each of which has a sequence of steps. For example, a tutorial might provide a walkthrough of a code sample that illustrates a certain feature of GeoidApp. Tutorials can include surface-level explanations, but should link to related concept topics for deep explanations.

To write a new tutorial page, create a Markdown file in a subdirectory of the /docs/tutorials directory. In your Markdown file, provide values for these variables, and then include templates/tutorial.md:

• overview - required
• prerequisites - required
• objectives - required
• lessoncontent - required
• cleanup - optional
• whatsnext - optional

Here's an example of a Markdown file that uses the tutorial template:

---
---

{% capture overview %}
This page shows how to ...
{% endcapture %}

{% capture prerequisites %}
* Do this.
* Do this too.
{% endcapture %}

{% capture objectives %}
* Learn this.
* Build this.
* Run this.
{% endcapture %}

{% capture lessoncontent %}
### Building ...

1. Do this.
1. Do this next. Possibly read this [related explanation](...).

### Running ...

1. Do this.
1. Do this next.

### Understanding the code
Here's something interesting about the code you ran in the preceding steps.
{% endcapture %}

{% capture cleanup %}
* Delete this.
* Stop this.
{% endcapture %}

{% capture whatsnext %}
* Learn more about [this](...).
* See this [related tutorial](...).
{% endcapture %}

{% include templates/tutorial.md %}