Skip to content

Commit

Permalink
Merge pull request #4619 from thomasgohard/docs-equalheight
Browse files Browse the repository at this point in the history 
[Documentation] Added documentation for equal height plugin (English and French)
  • Loading branch information
@nschonni
nschonni committed Feb 20, 2014
2 parents a5bac8f + 339e7d3 commit 9b1135f
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 155 deletions.
91 changes: 20 additions & 71 deletions site/pages/docs/ref/equalheight/equalheight-en.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,98 +11,40 @@

<section>
<h2>Purpose</h2>
<p>A brief description of the component.</p>
<p>Equalises the height of elements that are on the same baseline.</p>
</section>

<section>
<h2>Use when</h2>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</li>
<li>Elements of varying heights are displayed on the same baseline.</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>
<p>No known use cases when this plugin should not be used.</p>
</section>

<section>
<h2>Working example</h2>
<p><a href="#">Link to a working example</a></p>
<p><a href="../../../demos/equalheight/equalheight-en.html">Working example of the equal height plugin</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>
<li>Add the class <code>wb-eqht</code> to the element that contains the elements for which you want the height to be equal.</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>
<p>There are no configuration options.</p>
</section>

<section>
<h2>Events</h2>
<p>Document the public events that can be used by implementers or developers.</p>
<table class="table">
<thead>
<tr>
Expand All @@ -113,20 +55,27 @@ Example of multi-line code</code></pre>
</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>
<td><code>txt-rsz.wb</code></td>
<td>The font size was changed.</td>
<td rowspan="4">Re-equalises the heights of all elements contained in a <code>wb-eqht</code> container.</td>
</tr>
<tr>
<td><code>win-rsz-width.wb</code></td>
<td>The width of the browser window was changed.</td>
</tr>
<tr>
<td><code>win-rsz-height.wb</code></td>
<td>The height of the browser window was changed.</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>
<td><code>tables-draw.wb</code></td>
<td>A <a href="../tables/tables-en.html">table</a> was drawn.</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/plugins/equalheight">Source code for the equal height plugin on GitHub</a></p>
</section>
115 changes: 31 additions & 84 deletions site/pages/docs/ref/equalheight/equalheight-fr.hbs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,127 +9,74 @@
---
<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>
<h2>Fonction</h2>
<p>Égalise la hauteur d'éléments étant sur la même ligne de base.</p>
</section>

<section>
<h2>Use when</h2>
<h2>Utiliser lorsque</h2>
<ul>
<li>Use case 1</li>
<li>Use case 2</li>
<li>Use case 3</li>
<li>Des éléments ayant des hauteurs différentes sont affichés sur la même ligne de base.</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>
<h2>Éviter lorsque</h2>
<p>Aucun cas d'utilisation n'est connu pour lequel l'utilisation de ce plugiciel devrait être évitée.</p>
</section>

<section>
<h2>Working example</h2>
<p><a href="#">Link to a working example</a></p>
<h2>Exemples pratiques</h2>
<p><a href="../../../demos/equalheight/equalheight-fr.html">Exemples pratiques du plugiciel d'égalisation des hauteurs</a></p>
</section>

<section>
<h2>How to implement</h2>
<h2>Comment implémenter le plucigiel</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>
<li>Ajouter la classe <code lang="en">wb-eqht</code> à l'élément qui contient les éléments pour lequels vous voulez égaliser les hauteurs.</li>
</ol>
</section>

<section>
<h2>Configuration options</h2>
<p>Document the public configuration options that can be used by implementers or developers.</p>
<h2>Paramètres de configuration</h2>
<p>Aucun paramètre de configuration.</p>
</section>

<section>
<h2>Événements</h2>
<table class="table">
<thead>
<tr>
<th>Option</th>
<th>Description</th>
<th>How to configure</th>
<th>Values</th>
<th>Événement</th>
<th>Déclencheur</th>
<th>Effet déclenché</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>
<td><code lang="en">txt-rsz.wb</code></td>
<td>La taille de la police de caractères à été changée.</td>
<td rowspan="4">Ré-égalise la hauteur de tous les éléments contenus dans un contenant <code lang="en">wb-eqht</code>.</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>
<td><code lang="en">win-rsz-width.wb</code></td>
<td>La largeur de la fenêtre du navigateur à été changée.</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>
<td><code lang="en">win-rsz-height.wb</code></td>
<td>La hauteur de la fenêtre du navigateur à été changée.</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>
<td><code lang="en">tables-draw.wb</code></td>
<td>Un <a href="../tables/tables-fr.html">tableau</a> à été déssiné.</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>
<h2>Code source</h2>
<p><a href="https://github.com/wet-boew/wet-boew/tree/v4.0/src/plugins/equalheight">Code source du plugiciel d'égalisation des hauteurs sur <span lang="en">GitHub</span></a></p>
</section>
</div>

0 comments on commit 9b1135f

Please sign in to comment.