Skip to content

Latest commit

 

History

History
84 lines (48 loc) · 3.49 KB

scientific-paper.md

File metadata and controls

84 lines (48 loc) · 3.49 KB
Metadata Author
This document has meta-data in the YAML format
Lesosoftware

XIV

Abstract

This is an example for a scientific paper written in Paged-Markdown 3. Its purpose is to showcase some of the document format's features, like automatic pagination, manual page-breaks, page-number styles, tables of contents, footnotes and figures. Feel free to hack around and try out the syntax explained throughout the text.

--

Table Of Contents

Table Of Figures

-- 0123

Main Headline

Sub Headline

The zero (0) before the 123-directive signals we want to reset page counting.

Let's put a decent amount of text on this first page, so we can test text alignment and justification.

Figure 1: Logarithm visualization tree (2015, G. Snyder – CC BY 3.0)

Above we can see our first figure; nicely placing itself between the paragraphs. So far, everything looks really nice and wonderful! Marvelous~.

Since we are writing in Markdown, we can extend our document using HTML at any point. For example, this page uses a custom element-tag <col-2>, which distributes text into a left and a right column.

The <col-2>-tag is defined inside our automatically loaded user stylesheet file design.css.

This last paragraph included inside the two-sided area generates enough vertical space for the sentences just below Figure 1, to move to the left column.

At this point we have closed the <col-2>-tag, causing the text to use the full width of the page again. As a last feature showcased on this page, it is time¹ for some footnotes²!

Figure 2: Bar chart of editors by week (2020, M. Miller – CC BY-SA 4.0)

Note, how the two footnotes are defined below this very sentence – yet, they are rendered on page 1.

This happens because Paged Markdown automatically places footnotes on the page they are first referenced on. Moreover, we just experienced an automatic page-break. As one would expect, the document format automatically breaks contents onto the next page whenever they exceed the bounds of the previous one.

-- ¹ This is a test for a footnote. ² Another Footnote (wow :D) it is much amazing.

Late Headline

This is the last page of the document.

We just experienced a manual page-break. It is syntactically expressed by two dashes -- that may be followed by optional page-numbering directives and footnote-definitions.

If you check in the Table Of Contents (TOC), you will notice that the document format places numbers behind entries automatically, based on what the entry references.

A TOC-entry could point to a headline or really any figure or other element in the document, as long as that element has an id="..." (attribute) in the final HTML.

Paged Markdown automatically assigns ids to any image with a text description (#figure-1, #figure-2, ...), as well as tables (#table-1, #table-2, ...).

<script src="../dist/paged.js"></script>