Skip to content

Commit

Permalink
Geomap: Added placeholder documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Jackson authored and Paul Jackson committed Mar 7, 2014
1 parent 4599853 commit e929e44
Show file tree
Hide file tree
Showing 6 changed files with 275 additions and 4 deletions.
132 changes: 132 additions & 0 deletions site/pages/docs/ref/geomap/geomap-en.hbs
View file
@@ -0,0 +1,132 @@
---
{
"title": "Geomap",
"language": "en",
"description": "Displays a dynamic map over which information from additional sources can be overlaid.",
"altLangPrefix": "geomap",
"dateModified": "2014-03-07"
}
---
<span class="wb-prettify all-pre hide"></span>

<section>
<h2>Purpose</h2>
<p>A brief description of the component.</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>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</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>
<ol>
<li>Step 1</li>
<li>Step 2
<pre><code>Example code</code></pre>
</li>
<li>Step 3
<pre><code>Example of multi-line code
Example of multi-line code
Example of multi-line code</code></pre>
</li>
<li>Step 4</li>
</ol>
</section>

<section>
<h2>Configuration options</h2>
<p>Document the public configuration options that can be used by implementers or developers.</p>
<table class="table">
<thead>
<tr>
<th>Option</th>
<th>Description</th>
<th>How to configure</th>
<th>Values</th>
</tr>
</thead>
<tbody>
<tr>
<td>Option 1</td>
<td>Brief description of the option</td>
<td>How to configure the option</td>
<td>
<dl>
<dt>Value 1 (default):</dt>
<dd>Brief description</dd>
<dt>Value 2:</dt>
<dd>Brief description</dd>
<dt>Value 3:</dt>
<dd>Brief description</dd>
</dl>
</td>
</tr>
<tr>
<td>Option 2</td>
<td>Brief description of the option</td>
<td>How to configure the option</td>
<td>
<dl>
<dt>Value 1 (default):</dt>
<dd>Brief description</dd>
<dt>Value 2:</dt>
<dd>Brief description</dd>
<dt>Value 3:</dt>
<dd>Brief description</dd>
</dl>
</td>
</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>
</section>
135 changes: 135 additions & 0 deletions site/pages/docs/ref/geomap/geomap-fr.hbs
View file
@@ -0,0 +1,135 @@
---
{
"title": "Géocarte",
"language": "fr",
"description": "Affiche une carte dynamique sur laquelle des informations de sources supplémentaires peuvent être superposées.",
"altLangPrefix": "geomap",
"dateModified": "2014-03-07"
}
---
<span class="wb-prettify all-pre hide"></span>

<div lang="en">
<p><strong>Needs translation</strong></p>
<section>
<h2>Purpose</h2>
<p>A brief description of the component.</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>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</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>
<ol>
<li>Step 1</li>
<li>Step 2
<pre><code>Example code</code></pre>
</li>
<li>Step 3
<pre><code>Example of multi-line code
Example of multi-line code
Example of multi-line code</code></pre>
</li>
<li>Step 4</li>
</ol>
</section>

<section>
<h2>Configuration options</h2>
<p>Document the public configuration options that can be used by implementers or developers.</p>
<table class="table">
<thead>
<tr>
<th>Option</th>
<th>Description</th>
<th>How to configure</th>
<th>Values</th>
</tr>
</thead>
<tbody>
<tr>
<td>Option 1</td>
<td>Brief description of the option</td>
<td>How to configure the option</td>
<td>
<dl>
<dt>Value 1 (default):</dt>
<dd>Brief description</dd>
<dt>Value 2:</dt>
<dd>Brief description</dd>
<dt>Value 3:</dt>
<dd>Brief description</dd>
</dl>
</td>
</tr>
<tr>
<td>Option 2</td>
<td>Brief description of the option</td>
<td>How to configure the option</td>
<td>
<dl>
<dt>Value 1 (default):</dt>
<dd>Brief description</dd>
<dt>Value 2:</dt>
<dd>Brief description</dd>
<dt>Value 3:</dt>
<dd>Brief description</dd>
</dl>
</td>
</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>
</section>
</div>
3 changes: 2 additions & 1 deletion site/pages/docs/ref/plugins-en.hbs
View file
Expand Up @@ -4,7 +4,7 @@
"language": "en",
"description": "Plugins - Documentation - Web Experience Toolkit (WET)",
"altLangPrefix": "plugins",
"dateModified": "2014-02-19"
"dateModified": "2014-03-07"
}
---
<p>A WET plugin provides various types of functionality useful to a website and provided by calling the function in the class attribute of an HTML tag.</p>
Expand All @@ -21,6 +21,7 @@
<li><a href="feeds/feeds-en.html">Feeds</a> - Aggregates and displays entries from one or more Web feeds.</li>
<li><a href="footnotes/footnotes-en.html">Footnotes</a> - Provides a consistent, accessible way of handling footnotes across websites.</li>
<li><a href="formvalid/formvalid-en.html">Form validation</a> - Provides generic validation and error message handling for Web forms.</li>
<li><a href="geomap/geomap-en.html">Geomap</a> - Displays a dynamic map over which information from additional sources can be overlaid.</li>
<li><a href="lightbox/lightbox-en.html">Lightbox</a> - Helps build a photo gallery on a web page.</li>
<li><a href="menu/menu-en.html">Menu</a> - Provides an interactive menu with optional sub-menus.</li>
<li><a href="multimedia/multimedia-en.html">Multimedia player</a> - Provides an accessible multimedia player for embedding video and audio into web pages.</li>
Expand Down
3 changes: 2 additions & 1 deletion site/pages/docs/ref/plugins-fr.hbs
View file
Expand Up @@ -4,7 +4,7 @@
"language": "fr",
"description": "Plugiciels - Documentation - Boîte à outils de l'expérience Web (BOEW)",
"altLangPrefix": "plugins",
"dateModified": "2014-02-19"
"dateModified": "2014-03-07"
}
---
<p lang="en"><strong>Needs translation</strong> A WET plugin provides various types of functionality useful to a website and provided by calling the function in the class attribute of an HTML tag.</p>
Expand All @@ -23,6 +23,7 @@
<li><a href="feeds/feeds-fr.html">Fils de syndication</a> - Affiche les articles d’un ou plus fils de syndication.</li>
<li><a href="feedback/feedback-fr.html">Formulaire de rétroaction</a> - Un formulaire normalisé pour soumettre une rétroaction au sujet d'une page ou d'un site Web particulier.</li>
<li><a href="share/share-fr.html">Gadget de partage</a> - Permet à l'utilisateur de partager un contenu Web sur les plateformes de médias sociaux.</li>
<li><a href="geomap/geomap-fr.html">Géocarte</a> - Affiche une carte dynamique sur laquelle des informations de sources supplémentaires peuvent être superposées.</li>
<li><a href="charts/charts-fr.html">Graphiques</a> - Génère des graphiques à partir de données d’un tableau.</li>
<li><a href="tabs/tabs-fr.html">Interface à onglets</a> - Comprime plusieurs sections de contenu dans le même espace physique et fourni des onglets qui permettent à l'utilisateur de choisi la section de contenu à afficher.</li>
<li><a href="multimedia/multimedia-fr.html">Lecteur multimédia</a> - Un lecteur multimédia accessible permettant d'intégrer des contenus vidéo et audio sur les pages Web.</li>
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/geomap/geomap-en.hbs
View file
Expand Up @@ -6,7 +6,8 @@
"description": "Displays a dynamic map over which information from additional sources can be overlaid.",
"tag": "geomap",
"altLangPrefix": "geomap",
"js": "demo/popup_function"
"js": "demo/popup_function",
"dateModified": "2014-03-07"
}
---
<!-- GeomapStart -->
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/geomap/geomap-fr.hbs
View file
Expand Up @@ -6,7 +6,8 @@
"description": "Affiche une carte dynamique sur laquelle des informations de sources supplémentaires peuvent être superposées.",
"tag": "geomap",
"altLangPrefix": "geomap",
"js": "demo/popup_function"
"js": "demo/popup_function",
"dateModified": "2014-03-07"
}
---
<!-- GeomapStart -->
Expand Down

0 comments on commit e929e44

Please sign in to comment.