See http://etherbox.lan:9001/p/template.observation for an example of the structure of an observation.

# Markdown template style guide

While Markdown is a relatively standard way to specify formatting, the devil is always in the details -- how do you separate sections? Do you use h2 or h3 for subsections?

This is our attempt to agree on a way to format all the Markdown pads so that we get beautiful outputs.

We're following Pandoc's Markdown implementation; its documentation is available at <http://pandoc.org/MANUAL.html#pandocs-markdown>.

## Heading levels

* **h1** is used only for the title of the pad on the first line
* **h2** for section titles
* **h3** for subsection titles 
* (but what's really a section and a subsection? where are the boundaries? how sub can you get? har har)
(use `#` at the start of the line for a header. The number of `#` specifies the header level, e.g. `###` for h3.)

## Links

We're using automatic links from Pandoc's Markdown implementation, e.g. <http://duckduckgo.com>. This is so that printed PDF show the actual URL and not just the underlined title.

## Images

Use this Markdownsyntax: (the spaces are important)
(If you are reading this on the etherpad, do *not* include the "backticks" (` ` `)

```    
```

## Footnotes

```
This is a text with a footnote[^1]

[^1]: footnote content
```

You can also use text as the footnote tag, e.g. `[^survivalguide]`.

## Formatting reminders

* **bold** text
* _italic_ text
* ~~strikethrough~~ text
* **_bold & italic_**
* headers
  * `#` Heading level 1
  * `##` Heading level 2
  * `###` Heading level 3
  * `####` Heading level 4
  * `#####` Heading level 5
  * `######` Heading level 6
* lists, just like this one
  * indented lists
    * are fun and
      * there's no end to the nesting
* code blocks appear in `monospace`
* line-breaks `  ` - add two empty spaces in the end of the line

1.  this is
1. an ordered
1. list!

> blockquotes can be long
> long long long long
> long long long long long

```
code that spans many lines
we call this a "fenced code block"
```

```python
# you can specify the programming language
# at the beginning of the fenced code block (see source)
import meditation
hello = "and it gets proper syntax highlighting"
print(hello)
```

## Formatted pads

* <http://etherbox.local:9001/p/constellationofwares.md>
* <http://etherbox.local:9001/p/etherboxmanual.md>
* <http://etherbox.local:9001/p/programme.md>
* <http://etherbox.local:9001/p/jans_heuns.md>
* <http://etherbox.local:9001/p/participants.md>
* <http://etherbox.local:9001/p/files.md> _wip_

## PDF specific

\Huge Techno-Galactic Software Observatory  
\huge Techno-Galactic Software Observatory  
\LARGE Techno-Galactic Software Observatory  
\Large Techno-Galactic Software Observatory  
\large Techno-Galactic Software Observatory  
\normalsize Techno-Galactic Software Observatory  
\small Techno-Galactic Software Observatory  
\footnotesize Techno-Galactic Software Observatory  
\scriptsize Techno-Galactic Software Observatory  
\tiny Techno-Galactic Software Observatory  
\normalsize Back to normal.  

## Including other PADS

The markup for including other pads is:

    ! http://etherbox.lan:9001/p/template.observation

## Including pages from a PDF

The markup for including pages from another PDF is

for some pages (range)

• ! http://etherbox.lan:9001/p/template.observation#page=2,3
• 
  

one page

• ! http://etherbox.lan:9001/p/template.observation#page=2
• 
  

the whole thing

• ! http://etherbox.lan:9001/p/template.observation