From e929e440ebd92de5c9b65410a84388f14fcc12ba Mon Sep 17 00:00:00 2001 From: Paul Jackson Date: Fri, 7 Mar 2014 13:23:10 -0500 Subject: [PATCH] Geomap: Added placeholder documentation --- site/pages/docs/ref/geomap/geomap-en.hbs | 132 ++++++++++++++++++++++ site/pages/docs/ref/geomap/geomap-fr.hbs | 135 +++++++++++++++++++++++ site/pages/docs/ref/plugins-en.hbs | 3 +- site/pages/docs/ref/plugins-fr.hbs | 3 +- src/plugins/geomap/geomap-en.hbs | 3 +- src/plugins/geomap/geomap-fr.hbs | 3 +- 6 files changed, 275 insertions(+), 4 deletions(-) create mode 100644 site/pages/docs/ref/geomap/geomap-en.hbs create mode 100644 site/pages/docs/ref/geomap/geomap-fr.hbs diff --git a/site/pages/docs/ref/geomap/geomap-en.hbs b/site/pages/docs/ref/geomap/geomap-en.hbs new file mode 100644 index 00000000000..e8ab21f825a --- /dev/null +++ b/site/pages/docs/ref/geomap/geomap-en.hbs @@ -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" +} +--- + + +
+

Purpose

+

A brief description of the component.

+
+ +
+

Use when

+ +
+ +
+

Do not use when

+ +
+ +
+

Working example

+

Link to a working example

+
+ +
+

How to implement

+
    +
  1. Step 1
    2. +
  2. Step 2 + 
    Example code
    +
    3. +
  3. Step 3 + 
    Example of multi-line code
+Example of multi-line code
+Example of multi-line code
    +
    4. +
  4. Step 4
    5. +
+
+ +
+

Configuration options

+

Document the public configuration options that can be used by implementers or developers.

+ + + + + + + + + + + + + + + + + + + + + + + +
OptionDescriptionHow to configureValues
Option 1Brief description of the optionHow to configure the option +
+
Value 1 (default):
+
Brief description
+
Value 2:
+
Brief description
+
Value 3:
+
Brief description
+
+
Option 2Brief description of the optionHow to configure the option +
+
Value 1 (default):
+
Brief description
+
Value 2:
+
Brief description
+
Value 3:
+
Brief description
+
+
+
+ +
+

Events

+

Document the public events that can be used by implementers or developers.

+ + + + + + + + + + + + + + + + + + + + +
EventTriggerWhat it does
Event 1When the event is triggered and how to trigger it manually (where supported)Brief description of what it does.
Event 2When the event is triggered and how to trigger it manually (where supported)Brief description of what it does.
+
+ +
+

Source code

+

Link to the folder on GitHub containing the files for the component

+
diff --git a/site/pages/docs/ref/geomap/geomap-fr.hbs b/site/pages/docs/ref/geomap/geomap-fr.hbs new file mode 100644 index 00000000000..cb4a4395474 --- /dev/null +++ b/site/pages/docs/ref/geomap/geomap-fr.hbs @@ -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" +} +--- + + +
+

Needs translation

+
+

Purpose

+

A brief description of the component.

+
+ +
+

Use when

+
    +
  • Use case 1
    • +
  • Use case 2
    • +
  • Use case 3
    • +
+
+ +
+

Do not use when

+
    +
  • Use case 1
    • +
  • Use case 2
    • +
  • Use case 3
    • +
+
+ +
+

Working example

+

Link to a working example

+
+ +
+

How to implement

+
    +
  1. Step 1
    2. +
  2. Step 2 + 
    Example code
    +
    3. +
  3. Step 3 + 
    Example of multi-line code
+Example of multi-line code
+Example of multi-line code
    +
    4. +
  4. Step 4
    5. +
+
+ +
+

Configuration options

+

Document the public configuration options that can be used by implementers or developers.

+ + + + + + + + + + + + + + + + + + + + + + + +
OptionDescriptionHow to configureValues
Option 1Brief description of the optionHow to configure the option +
+
Value 1 (default):
+
Brief description
+
Value 2:
+
Brief description
+
Value 3:
+
Brief description
+
+
Option 2Brief description of the optionHow to configure the option +
+
Value 1 (default):
+
Brief description
+
Value 2:
+
Brief description
+
Value 3:
+
Brief description
+
+
+
+ +
+

Events

+

Document the public events that can be used by implementers or developers.

+ + + + + + + + + + + + + + + + + + + + +
EventTriggerWhat it does
Event 1When the event is triggered and how to trigger it manually (where supported)Brief description of what it does.
Event 2When the event is triggered and how to trigger it manually (where supported)Brief description of what it does.
+
+ +
+

Source code

+

Link to the folder on GitHub containing the files for the component

+
+
diff --git a/site/pages/docs/ref/plugins-en.hbs b/site/pages/docs/ref/plugins-en.hbs index f94da4bac8e..9b1b9cb55bb 100644 --- a/site/pages/docs/ref/plugins-en.hbs +++ b/site/pages/docs/ref/plugins-en.hbs @@ -4,7 +4,7 @@ "language": "en", "description": "Plugins - Documentation - Web Experience Toolkit (WET)", "altLangPrefix": "plugins", - "dateModified": "2014-02-19" + "dateModified": "2014-03-07" } ---

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.

@@ -21,6 +21,7 @@
  • Feeds - Aggregates and displays entries from one or more Web feeds.
  • Footnotes - Provides a consistent, accessible way of handling footnotes across websites.
  • Form validation - Provides generic validation and error message handling for Web forms.
    • +
  • Geomap - Displays a dynamic map over which information from additional sources can be overlaid.
  • Lightbox - Helps build a photo gallery on a web page.
  • Menu - Provides an interactive menu with optional sub-menus.
  • Multimedia player - Provides an accessible multimedia player for embedding video and audio into web pages.
    • diff --git a/site/pages/docs/ref/plugins-fr.hbs b/site/pages/docs/ref/plugins-fr.hbs index 6c5716005c1..687ea552eeb 100644 --- a/site/pages/docs/ref/plugins-fr.hbs +++ b/site/pages/docs/ref/plugins-fr.hbs @@ -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" } ---

    Needs translation 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.

    @@ -23,6 +23,7 @@
  • Fils de syndication - Affiche les articles d’un ou plus fils de syndication.
  • Formulaire de rétroaction - Un formulaire normalisé pour soumettre une rétroaction au sujet d'une page ou d'un site Web particulier.
  • Gadget de partage - Permet à l'utilisateur de partager un contenu Web sur les plateformes de médias sociaux.
    • +
  • Géocarte - Affiche une carte dynamique sur laquelle des informations de sources supplémentaires peuvent être superposées.
  • Graphiques - Génère des graphiques à partir de données d’un tableau.
  • Interface à onglets - 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.
  • Lecteur multimédia - Un lecteur multimédia accessible permettant d'intégrer des contenus vidéo et audio sur les pages Web.
    • diff --git a/src/plugins/geomap/geomap-en.hbs b/src/plugins/geomap/geomap-en.hbs index 3ec565e0ec1..b0e412438c6 100644 --- a/src/plugins/geomap/geomap-en.hbs +++ b/src/plugins/geomap/geomap-en.hbs @@ -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" } --- diff --git a/src/plugins/geomap/geomap-fr.hbs b/src/plugins/geomap/geomap-fr.hbs index 8d7145fa7f1..98100cbc0a4 100644 --- a/src/plugins/geomap/geomap-fr.hbs +++ b/src/plugins/geomap/geomap-fr.hbs @@ -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" } ---