Skip to content
Permalink
Browse files

Documentation: Added partial documentation for several plugins

  • Loading branch information...
pjackson28 committed Mar 31, 2014
1 parent baf9177 commit 81dd222d29e31f02f2839566feb10e543fa82555
@@ -2,42 +2,50 @@
{
"title": "ARCHIVED - Archiving content",
"language": "en",
"description": "Provides a breakdown of WCAG 2.0 accessibility responsibilities throughout the Web production chain.",
"description": "Helps users identify Web pages that have been archived online.",
"altLangPrefix": "archived",
"dateModified": "2014-02-19"
"dateModified": "2014-03-31"
}
---
<span class="wb-prettify all-pre hide"></span>

<section>
<h2>Purpose</h2>
<p>A brief description of the component.</p>
<p>Helps users identify Web pages that have been archived online.</p>
</section>

<section>
<h2>Use when</h2>
<p>This approach is mandatory for Government of Canada Web pages that have been archived online.</p>
<p>A Web page can be archived online if it is:</p>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</li>
<li>maintained for reference, research or record keeping purposes;</li>
<li>will not be altered or updated after the date of archiving; and</li>
<li>stored in a digital repository.</li>
</ul>
<p>Examples include; a new policy that has replaced an old policy, older versions of reports, events that have happened in the past (such as conferences).</p>
</section>

<section>
<h2>Do not use when</h2>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</li>
<li>The Web page includes current content.</li>
<li>In place of removing redundant, outdated and trivial content (ROT).</li>
<li>As an excuse not to make Web pages compliant to the new Standard on Web Accessibility (WCAG 2.0).</li>
</ul>
</section>

<section>
<h2>Working example</h2>
<p><a href="#">Link to a working example</a></p>
<ul>
<li><a href="../../../demos/archived/archived-en.html">English example</a></li>
<li><a href="../../../demos/archived/archived-fr.html">French example</a></li>
</ul>
</section>

<section>
<p>Coming soon</p>
<!--
<h2>How to implement</h2>
<ol>
<li>Step 1</li>
@@ -51,10 +59,13 @@ Example of multi-line code</code></pre>
</li>
<li>Step 4</li>
</ol>
-->
</section>

<section>
<h2>Configuration options</h2>
<p>Coming soon</p>
<!--
<p>Document the public configuration options that can be used by implementers or developers.</p>
<table class="table">
<thead>
@@ -98,35 +109,10 @@ Example of multi-line code</code></pre>
</tr>
</tbody>
</table>
</section>

<section>
<h2>Events</h2>
<p>Document the public events that can be used by implementers or developers.</p>
<table class="table">
<thead>
<tr>
<th>Event</th>
<th>Trigger</th>
<th>What it does</th>
</tr>
</thead>
<tbody>
<tr>
<td>Event 1</td>
<td>When the event is triggered and how to trigger it manually (where supported)</td>
<td>Brief description of what it does.</td>
</tr>
<tr>
<td>Event 2</td>
<td>When the event is triggered and how to trigger it manually (where supported)</td>
<td>Brief description of what it does.</td>
</tr>
</tbody>
</table>
-->
</section>

<section>
<h2>Source code</h2>
<p><a href="#">Link to the folder on GitHub containing the files for the component</a></p>
<p><a href="https://github.com/wet-boew/wet-boew/tree/v4.0/src/other/archived">Archived content source code on GitHub</a></p>
</section>
@@ -4,7 +4,7 @@
"language": "fr",
"description": "Ajoute un avis d'archivage à une page Web.",
"altLangPrefix": "archived",
"dateModified": "2014-02-19"
"dateModified": "2014-03-31"
}
---
<span class="wb-prettify all-pre hide"></span>
@@ -13,33 +13,41 @@
<p><strong>Needs translation</strong></p>
<section>
<h2>Purpose</h2>
<p>A brief description of the component.</p>
<p>Helps users identify Web pages that have been archived online.</p>
</section>

<section>
<h2>Use when</h2>
<p>This approach is mandatory for Government of Canada Web pages that have been archived online.</p>
<p>A Web page can be archived online if it is:</p>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</li>
<li>maintained for reference, research or record keeping purposes;</li>
<li>will not be altered or updated after the date of archiving; and</li>
<li>stored in a digital repository.</li>
</ul>
<p>Examples include; a new policy that has replaced an old policy, older versions of reports, events that have happened in the past (such as conferences).</p>
</section>

<section>
<h2>Do not use when</h2>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</li>
<li>The Web page includes current content.</li>
<li>In place of removing redundant, outdated and trivial content (ROT).</li>
<li>As an excuse not to make Web pages compliant to the new Standard on Web Accessibility (WCAG 2.0).</li>
</ul>
</section>

<section>
<h2>Working example</h2>
<p><a href="#">Link to a working example</a></p>
<ul>
<li><a href="../../../demos/archived/archived-en.html">English example</a></li>
<li><a href="../../../demos/archived/archived-fr.html">French example</a></li>
</ul>
</section>

<section>
<p>Coming soon</p>
<!--
<h2>How to implement</h2>
<ol>
<li>Step 1</li>
@@ -53,10 +61,13 @@ Example of multi-line code</code></pre>
</li>
<li>Step 4</li>
</ol>
-->
</section>

<section>
<h2>Configuration options</h2>
<p>Coming soon</p>
<!--
<p>Document the public configuration options that can be used by implementers or developers.</p>
<table class="table">
<thead>
@@ -100,36 +111,11 @@ Example of multi-line code</code></pre>
</tr>
</tbody>
</table>
</section>

<section>
<h2>Events</h2>
<p>Document the public events that can be used by implementers or developers.</p>
<table class="table">
<thead>
<tr>
<th>Event</th>
<th>Trigger</th>
<th>What it does</th>
</tr>
</thead>
<tbody>
<tr>
<td>Event 1</td>
<td>When the event is triggered and how to trigger it manually (where supported)</td>
<td>Brief description of what it does.</td>
</tr>
<tr>
<td>Event 2</td>
<td>When the event is triggered and how to trigger it manually (where supported)</td>
<td>Brief description of what it does.</td>
</tr>
</tbody>
</table>
-->
</section>

<section>
<h2>Source code</h2>
<p><a href="#">Link to the folder on GitHub containing the files for the component</a></p>
<p><a href="https://github.com/wet-boew/wet-boew/tree/v4.0/src/other/archived">Archived content source code on GitHub</a></p>
</section>
</div>
@@ -4,41 +4,28 @@
"language": "en",
"description": "A basic AjaxLoader wrapper that inserts AJAXed-in content based on a visitor's country as determined by http://freegeoip.net",
"altLangPrefix": "country-content",
"dateModified": "2014-02-19"
"dateModified": "2014-03-31"
}
---
<span class="wb-prettify all-pre hide"></span>

<section>
<h2>Purpose</h2>
<p>A brief description of the component.</p>
<p>A basic AjaxLoader wrapper that inserts AJAXed-in content based on a visitor's country as determined by http://freegeoip.net.</p>
</section>

<section>
<h2>Use when</h2>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</li>
</ul>
</section>

<section>
<h2>Do not use when</h2>
<h2>Working example</h2>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</li>
<li><a href="../../../demos/country-content/country-content-en.html">English example</a></li>
<li><a href="../../../demos/country-content/country-content-fr.html">French example</a></li>
</ul>
</section>

<section>
<h2>Working example</h2>
<p><a href="#">Link to a working example</a></p>
</section>

<section>
<h2>How to implement</h2>
<p>Coming soon</p>
<!--
<ol>
<li>Step 1</li>
<li>Step 2
@@ -51,10 +38,13 @@ Example of multi-line code</code></pre>
</li>
<li>Step 4</li>
</ol>
-->
</section>

<section>
<h2>Configuration options</h2>
<p>Coming soon</p>
<!--
<p>Document the public configuration options that can be used by implementers or developers.</p>
<table class="table">
<thead>
@@ -98,10 +88,13 @@ Example of multi-line code</code></pre>
</tr>
</tbody>
</table>
-->
</section>

<section>
<h2>Events</h2>
<p>Coming soon</p>
<!--
<p>Document the public events that can be used by implementers or developers.</p>
<table class="table">
<thead>
@@ -124,9 +117,10 @@ Example of multi-line code</code></pre>
</tr>
</tbody>
</table>
-->
</section>

<section>
<h2>Source code</h2>
<p><a href="#">Link to the folder on GitHub containing the files for the component</a></p>
<p><a href="https://github.com/wet-boew/wet-boew/tree/v4.0/src/plugins/country-content">Country content plugin source code on GitHub</a></p>
</section>
Oops, something went wrong.

0 comments on commit 81dd222

Please sign in to comment.
You can’t perform that action at this time.