ap.38.fail/legislation/document.formatting.act.202...

90 lines
3.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>AP Legislation</title>
<link rel="icon" type="image/x-icon" href="../media/img/flags/ap.png">
<link rel="stylesheet" href="style.css">
</head>
<body>
<table width="900" cellpadding="3" border="0" bgcolor=#d5e4c3 text=#090909>
<tbody>
<tr>
<td>
<center>
<a href="../index.htm"><img src="../media/img/flags/ap.png"></a>
<h4 style="margin: 0">AP Legislation</h4>
</center>
</td>
</tr>
<tr>
<td valign=top bgcolor=#fefefe>
<div class="legislation">
<h1 id="document-formatting-act-2022">Document Formatting Act 2022</h1>
<p>This document outlines the required usage of the CommonMark Markdown
specification within Arsenio Pact documents for the purpose of
standardization.</p>
<p>For information about the Markdown format not covered within the
contents of this document, consult the <a
href="https://spec.commonmark.org/">CommonMark Specification</a>.</p>
<p>This document was written by members of the Anyakovan Institute of
Technology (AKIT) to promote concise writing &amp; easy dissemination of
legal material to the public.</p>
<h2 id="motivation">Motivation</h2>
<p>There is an unnecessary overhead for auditors of the Arsenio Pacts
documents, and a simple, foolproof standard would greatly improve the
archival process.</p>
<p>Markdown is a good compromise between functionality &amp; ease of
use; it is readable as both plaintext or parsed in a variety of formats,
namely HTML, PDF, or ODT.</p>
<p>The CommonMark specification is an ideal default specification to
adhere to, due to its barebones feature set and loose formatting.</p>
<h2 id="implementation">Implementation</h2>
<p>The Arsenio Pact &amp; its member states must do the following:</p>
<ul>
<li>Write all future documents in the CommonMark Markdown specification.
<ul>
<li>Documents must use the <code>.md</code>, <code>mkdn</code>,
<code>.mdown</code>, or <code>.markdown</code> file extensions.</li>
<li>Documents must not use unsupported extensions of the Markdown format
that are not present within CommonMark. This is especially important
when converting documents using GFM (Github Flavoured Markdown).</li>
<li>For compatibility, documents must not contain inline HTML.</li>
</ul></li>
<li>Convert all previous documents to Markdown.</li>
</ul>
<p>Additionally, writers are encouraged (but not required) to do the
following:</p>
<ul>
<li>Use a proper CommonMark compatible editor, such as <a
href="https://vscodium.com/">VSCodium</a>, <a
href="https://atom.io/">Atom</a>, <a href="https://brackets.io/">Adobe
Brackets</a>, or <a href="markdown.pioul.fr/">MOME</a>.</li>
<li>Use a Markdown Linter, such as <a
href="https://github.com/DavidAnson/vscode-markdownlint">vscode-markdownlint</a>.</li>
</ul>
<h3 id="applicable-documents">Applicable Documents</h3>
<p>The usage of the term “official document” describes legislation,
treaties, guidelines, and any other information intended for
distribution to an administrative body.</p>
<h2 id="exemptions">Exemptions</h2>
<p>This law may be reevaluated to further extend the list of supported
formats. Another format can be introduced if it adheres to the
following:</p>
<ul>
<li>Can be written without a compatible editor.</li>
<li>Can be quickly converted to HTML &amp; PDF.</li>
</ul>
<p>Common examples of compatible text formats include
<code>.textile</code>, <code>.rdoc</code>, <code>.org</code>,
<code>.creole</code>, <code>.mediawiki</code>/<code>wiki</code>,
<code>.rst</code>,
<code>.asciidoc</code>/<code>adoc</code>/<code>asc</code>, &amp;
<code>.pod</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</body>
</html>