Skip to content

Commit

Permalink
fix(help): add new help sections
Browse files Browse the repository at this point in the history
add wms query, map export, and updated settings panel
entries

Closes #8836
  • Loading branch information
james-rae authored and AleksueiR committed Jul 6, 2015
1 parent 37c251c commit 1381b83
Show file tree
Hide file tree
Showing 11 changed files with 118 additions and 8 deletions.
76 changes: 76 additions & 0 deletions site/includes/help.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,11 @@
<div>
<div class="helpSectionBody">
<p>{{t "help.s6.p1"}}</p>

<!-- Usage -->
<h3 class="h5">{{t "help.s6.h1"}}</h3>

<!-- Layer Types -->
<h4>{{t "help.s6.h2"}}</h4>

<figure class="thumbnail col-md-4 pull-right">
Expand All @@ -116,10 +120,25 @@
<li>{{t "help.s6.ul2.li2"}}</li>
<li>{{t "help.s6.ul2.li3"}}</li>
</ul>

<!-- Layer Visibility -->
<h4>{{t "help.s6.h3"}}</h4>
<p>{{t "help.s6.p3"}}</p>

<!-- WMS Query Toggle -->
<h4>{{t "help.s6.h4"}}</h4>
<figure class="thumbnail col-md-4 pull-right">
<a class="wb-lbx" href="./assets/images/help/{{t "page.lang.main"}}/layer_wms_query.png" title="{{t "help.s6.img4"}}">
<img src="./assets/images/help/{{t "page.lang.main"}}/layer_wms_query.png" alt="{{t "help.s6.img4"}}" class="" />
</a>
<figcaption class="caption text-right">
<p class="mrgn-tp-sm mrgn-bttm-sm pstn-bttm-md pstn-rght-md caption-header small">{{t "help.s6.img4"}}</p>
</figcaption>
</figure>
<p>{{t "help.s6.p4"}}</p>
<div class="clearfix"></div>

<!-- Layer Legends -->
<h4>{{t "help.s6.h5"}}</h4>
<figure class="thumbnail col-md-4 pull-right">
<a class="wb-lbx" href="./assets/images/help/{{t "page.lang.main"}}/layer_legends.png" title="{{t "help.s6.img5"}}">
Expand All @@ -131,6 +150,8 @@
</figure>
<p>{{t "help.s6.p5"}}</p>
<div class="clearfix"></div>

<!-- Handling Layer Errors -->
<h4>{{t "help.s6.h6"}}</h4>
<figure class="thumbnail col-md-4 pull-right">
<a class="wb-lbx" href="./assets/images/help/{{t "page.lang.main"}}/layer_errors.png" title="{{t "help.s6.img6"}}">
Expand All @@ -143,6 +164,8 @@
<p>{{t "help.s6.p6"}}</p>

<div class="clearfix"></div>

<!-- Layer Reordering -->
<h4>{{t "help.s6.h7"}}</h4>

<figure class="thumbnail col-md-4 pull-right">
Expand All @@ -166,10 +189,28 @@
<p>{{t "help.s6.p7a"}}</p>
<div class="clearfix"></div>

<!-- Layer Metadata -->
<h4>{{t "help.s6.h8"}}</h4>
<p>{{t "help.s6.p8"}}</p>

<!-- Layer Settings -->
<h4>{{t "help.s6.h9"}}</h4>
<figure class="thumbnail col-md-4 pull-right">
<a class="wb-lbx" href="./assets/images/help/{{t "page.lang.main"}}/layer_settings.png" title="{{t "help.s6.img9"}}">
<img src="./assets/images/help/{{t "page.lang.main"}}/layer_settings.png" alt="{{t "help.s6.img9"}}" class="" />
</a>
<figcaption class="caption text-right">
<p class="mrgn-tp-sm mrgn-bttm-sm pstn-bttm-md pstn-rght-md caption-header small">{{t "help.s6.img9"}}</p>
</figcaption>
</figure>
<p>{{t "help.s6.p9"}}</p>
<ul>
<li>{{t "help.s6.ul9.li1"}}</li>
<li>{{t "help.s6.ul9.li2"}}</li>
<li>{{t "help.s6.ul9.li3"}}</li>
</ul>

<!-- Zoom Scale Dependent Layers -->
<h4>{{t "help.s6.h10"}}</h4>
<figure class="thumbnail col-md-4 pull-right">
<a class="wb-lbx" href="./assets/images/help/{{t "page.lang.main"}}/layer_zoom_scale.png" title="{{t "help.s6.img10"}}">
Expand Down Expand Up @@ -406,6 +447,41 @@
<div class="clearfix">
</div>
<!-- infoPanel ENDS -->
<!-- map export BEGINS -->
<details class="mrgn-tp-0">
<summary class="h5 mrgn-tp-0 mrgn-bttm-md">{{t "help.s13.header"}}</summary>
<div>
<div class="helpSectionBody">
<p>{{t "help.s13.p1"}}</p>
<h3 class="h5">{{t "help.s13.h1"}}</h3>

<figure class="thumbnail col-md-4 pull-right">
<a class="wb-lbx" href="./assets/images/help/{{t "page.lang.main"}}/help_map_export.png" title="{{t "help.s13.img1"}}">
<img src="./assets/images/help/{{t "page.lang.main"}}/help_map_export.png" alt="{{t "help.s13.img1"}}" class="image-actual" />
</a>
<figcaption class="caption text-right">
<p class="mrgn-tp-sm mrgn-bttm-sm pstn-bttm-md pstn-rght-md caption-header small">{{t "help.s13.img1"}}</p>
</figcaption>
</figure>
<p>{{t "help.s13.p2"}}</p>

<div class="clearfix"></div>
<h3 class="h5">{{t "help.s13.h2"}}</h3>
<figure class="thumbnail col-md-4 pull-right">
<a class="wb-lbx" href="./assets/images/help/{{t "page.lang.main"}}/help_map_export_download.png" title="{{t "help.s13.img2"}}">
<img src="./assets/images/help/{{t "page.lang.main"}}/help_map_export_download.png" alt="{{t "help.s13.img2"}}" class="image-actual" />
</a>
<figcaption class="caption text-right">
<p class="mrgn-tp-sm mrgn-bttm-sm pstn-bttm-md pstn-rght-md caption-header small">{{t "help.s13.img2"}}</p>
</figcaption>
</figure>
<p>{{t "help.s13.p3"}}</p>
</div>
</div>
</details>
<div class="clearfix">
</div>
<!-- map export ENDS -->
<!-- accessibility BEGINS -->
<details class="mrgn-tp-0">
<summary class="h5 mrgn-tp-0 mrgn-bttm-md">{{t "help.s10.header"}}</summary>
Expand Down
Binary file added src/assets/images/help/en/help_map_export.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/help/en/layer_settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/help/en/layer_wms_query.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/help/fr/help_map_export.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/help/fr/layer_settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/images/help/fr/layer_wms_query.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 22 additions & 5 deletions src/locales/en-CA/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,16 @@
"p1": "Load times may vary based on network location and bandwidth availability, and unanticipated behaviour may occur if any map interactions occur before data is fully loaded. Please allow the webpage to load completely before triggering any map functions.",
"p2": "If the \"Loading...\" text appears in the lower right corner of map or the data grid displays a loading message, please allow the loading indicator to disappear before triggering any function on the map."
},
"s13": {
"h1": "Usage",
"h2": "Limitations",
"header": "Map Export",
"img1": "The Toolbar Button",
"img2": "Download Image Button",
"p1": "Map Export is used to convert the contents of the map into an image that can be downloaded by the user.",
"p2": "Click the Map Export button in the toolbar to initiate the image generation. The Map Export window will open. A \"Loading\" message will display, and the image preview will appear once it is generated. Click the Download Image button to save the image. Click the X to close the Map Export window.",
"p3": "Currently Map Export will only capture layers that are hosted on a public internet service. Layers hosted privately (e.g. on an intranet) or added from file-based sources will not appear in the resultant image file. Images are currently only available in PNG format."
},
"s2": {
"h1": "Usage",
"header": "Basemaps",
Expand Down Expand Up @@ -445,7 +455,7 @@
"h10": "Zoom Scale Dependent Layers",
"h2": "Layer Types",
"h3": "Layer Visibility",
"h4": "Layer Bounding Box",
"h4": "WMS Queries Toggle",
"h5": "Layer Legends",
"h6": "Handling Layer Errors",
"h7": "Layer Reordering",
Expand All @@ -454,25 +464,32 @@
"header": "Datasets",
"img10": "Zoom Scale Dependent Layers",
"img2": "Datasets",
"img4": "WMS Queries Toggle",
"img5": "Legends",
"img6": "Layer Errors",
"img7": "Layer Reordering",
"img7a": "Layer Group Boundaries",
"img9": "Layer Settings",
"p1": "The Datasets tab lists the layers available to display in the map. Feature layers also display in the data grid. The Datasets tab also serves as a map legend.",
"p10": "Some layers may only be visible at certain zoom levels. If a layer is not visible at a given zoom level the layer selector will display a notice and have an action available to zoom to the closest zoom level at which the layer will be visible (this may involve either zooming in or zooming out).",
"p2": "There are three types of layers that can reside in the Dataset tab.",
"p3": "Select the \"eye\" icon next to a dataset name to toggle the layer on or off.",
"p4": "Use the \"cross hatch\" icon to the right of the eye icon to display the bounding box of the dataset.",
"p4": "When a user clicks on the map (and not on a feature), the results for any queryable WMS layer will be displayed for the location clicked. This behaviour may not be desired for certain layers. Clicking the WMS Query Enable/Disable icons on the right side of the layer selector will toggle this functionality for an individual layer. The global toggle at the top of the layer selector will enable or disable the function for all WMS layers. WMS layers that are not queryable will not have a toggle icon.",
"p5": "Each layer has some symbology associated with it. For simple feature layers a single icon will be present next to the layer name. For complex feature layers (i.e. those with multiple symbols used per layer) the icon will show as a stack and maybe toggled on and off. When toggled on a section will expand beneath the layer name and show the full symbology for the layer. WMS layers may optionally have a graphical legend defined, if one is present it will be displayed in the same drop down manner.",
"p6": "If a layer fails to load correctly it will be identified by an error notice. Instead of the standard layer actions you can select to either reload the layer (this is particularly helpful if there is a temporary network connectivity issue) or remove the layer. If a layer is removed it will be taken out of the layer selector completely and if it is added back via \"Add Dataset\" it will lose any previous customizations.",
"p7": "Click and drag the 6 dots to the left of the dataset up or down to re-order the layers on the map interface.",
"p7a": "While all layers can be re-ordered, WMS layers and Feature / Static layers may not be mixed together. When reordering layers, layers which cannot be mixed will be greyed out. Although layers can be reordered within their groups the grouping is static with feature and static layers always displaying over the WMS layer group.",
"p8": "Select the \"Metadata\" link to display relevant metadata for that source in a collapsible Info Panel.",
"p9": "Select the \"Settings\" link to change layer's opacity using the slider control.",
"p9": "Select the \"Settings\" link to access additional options for the layer.",
"ul2": {
"li1": "Feature layers represent data that can be interacted with on the map, and viewed in the data grid.",
"li2": "Static layers provide additional geographical context against the basemap. They are not interactive and do not show in the data grid.",
"li3": "WMS layers provide an overlay of data from a Web Map Service. They can support a click interaction on the map, and do not show in the data grid."
},
"ul9": {
"li1": "The layer's opacity can be adjusted using the slider control.",
"li2": "If the layer has a bounding box, its visibility can be toggled using the checkbox.",
"li3": "If the layer is a feature layer, and is in on-demand mode, the option to Load All Features is available. On-demand mode means the layer will be downloaded in parts as needed. Clicking Load All Features will cause all layer data to be loaded in the browser at once, providing snappier response times once the download completes. This is called snapshot mode. Attempting this with very large datasets may cause the site to stall or the layer to crash. A layer in snapshot mode will have the Load All Features link disabled and a checkmark beside the link."
}
},
"s7": {
Expand Down Expand Up @@ -552,8 +569,8 @@
"loading": "Generating image. Please wait.",
"title": "Map Export"
},
"maptips": {
"attribsDownloading" : "Attribute data is still downloading"
"maptips": {
"attribsDownloading": "Attribute data is still downloading"
},
"page": {
"footer": {
Expand Down
23 changes: 20 additions & 3 deletions src/locales/fr-CA/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,16 @@
"p1": "La durée des chargements peut varier selon l’emplacement réseau et la disponibilité de la largeur de bande. Un comportement imprévu peut survenir lorsque des interactions avec la carte ont lieu avant la conclusion du chargement des données. Veuillez permettre le chargement complet de la page Web avant d’activer d’autres fonctions sur la carte.",
"p2": "Lorsque la mention « Chargement » apparaît dans le coin inférieur droit de la carte ou lorsque la grille de données affiche un message de chargement en cours, attendez que l’indicateur de chargement disparaisse avant d’activer d’autres fonctions sur la carte."
},
"s13": {
"h1": "[fr] Usage",
"h2": "[fr] Limitations",
"header": "[fr] Map Export",
"img1": "[fr] The Toolbar Button",
"img2": "[fr] Download Image Button",
"p1": "[fr] Map Export is used to convert the contents of the map into an image that can be downloaded by the user.",
"p2": "[fr] Click the Map Export button in the toolbar to initiate the image generation. The Map Export window will open. A \"Loading\" message will display, and the image preview will appear once it is generated. Click the Download Image button to save the image. Click the X to close the Map Export window.",
"p3": "[fr] Currently Map Export will only capture layers that are hosted on a public internet service. Layers hosted privately (e.g. on an intranet) or added from file-based sources will not appear in the resultant image file. Images are currently only available in PNG format."
},
"s2": {
"h1": "Utilisation",
"header": "Fonds de carte",
Expand Down Expand Up @@ -445,7 +455,7 @@
"h10": "Couches dépendantes de l’échelle de zoom",
"h2": "Types de couche",
"h3": "Visibilité de la couche",
"h4": "Tracé des limites des couches",
"h4": "[fr] WMS Queries Toggle",
"h5": "Légende des couches",
"h6": "Traitement des erreurs de couche",
"h7": "Changement de l’ordre des couches",
Expand All @@ -454,25 +464,32 @@
"header": "Ensembles de données",
"img10": "Couches dépendantes de l’échelle de zoom",
"img2": "Ensembles de données",
"img4": "[fr] WMS Queries Toggle",
"img5": "Légendes",
"img6": "Erreurs de couche",
"img7": "Changement de l’ordre des couches",
"img7a": "Limites du groupe de couche",
"img9": "[fr] Layer Settings",
"p1": "Les ensembles de données présentent la liste des couches disponibles pour l’affichage sur la carte. La grille de données présente aussi les couches d’éléments interactifs. Les ensembles de données agissent également à titre de légende de la carte.",
"p10": "Certaines couches peuvent être visibles uniquement à certains niveaux de zoom. Si une couche n’est pas visible à un niveau de zoom donné, le sélecteur de couche (Layer Selector) affichera un avis et offrira une action afin d’établir un zoom au niveau de zoom le plus prêt auquel la couche sera visible (cela peut consister à faire un zoom in) ",
"p2": "Trois types de couche peuvent être présentés sous l’onglet « Ensemble de données ».",
"p3": "Sélectionnez l’icône en forme d’œil près du nom de l’ensemble de données pour masquer ou afficher la couche.",
"p4": "Cliquez sur l’icône hachurée placée à droite de l’icône en forme d’œil pour afficher le tracé des limites pour l’ensemble de données associé.",
"p4": "[fr] When a user clicks on the map (and not on a feature), the results for any queryable WMS layer will be displayed for the location clicked. This behaviour may not be desired for certain layers. Clicking the WMS Query Enable/Disable icons on the right side of the layer selector will toggle this functionality for an individual layer. The global toggle at the top of the layer selector will enable or disable the function for all WMS layers. WMS layers that are not queryable will not have a toggle icon.",
"p5": "Une certaine symbologie est associée à chaque couche. Pour des couches de fonctionnalité (feature layer) simples, une seule icône sera présente à côté du nom de la couche. Pour les couches de fonctionnalité complexes (c.-à-d. celles où de multiples symboles sont utilisés par couche), l’icône apparaîtra comme une pile qui peut être activée ou désactivée. Quand ",
"p6": "Si la couche ne se charge pas correctement, elle sera identifiée par un avis d’erreur. Au lieu des mesures standards liées à la couche, on peut choisir de recharger la couche (ce qui est particulièrement utile en cas de problème temporaire de connexion au réseau) ou de retirer la couche. Si une couche est […] ",
"p7": "Cliquez et faites glisser les six points à gauche de l’ensemble de données vers le haut ou vers le bas pour changer l’ordre d’affichage des couches sur la carte.",
"p7a": "Alors que toutes les couches peuvent être réordonnées, les couches WMS et les couches Fonctionnalité / Statique (Feature/Static) ne peuvent être mélangées. En réordonnant les couches, les couches qui ne peuvent être mélangées apparaîtront en gris. Même si les couches peuvent être réordonnées à l’intérieur de leurs groupes, le groupement est statique pour ce qui est des couches Feature et Static. ",
"p8": "Sélectionnez le lien « Métadonnées » pour afficher les métadonnées associées à cette source dans un panneau d’information repliable.",
"p9": "Sélectionnez le lien « Paramètres » pour modifier l’opacité de la couche à l’aide de la barre de contrôle.",
"p9": "[fr] Select the \"Settings\" link to access additional options for the layer.",
"ul2": {
"li1": "Les couches d’éléments interactifs affichent des données avec lesquelles on peut interagir sur la carte, et qui peuvent être affichées dans la grille de données.",
"li2": "Les couches statiques ajoutent un contexte géographique au fond de carte. Elles ne sont pas interactives et ne sont pas affichées dans la grille de données.",
"li3": "Les couches SCW sont des couches superposées de données fournies par un service de cartes Web. Ces données sont interactives sur la carte, mais ne sont pas affichées dans la grille de données."
},
"ul9": {
"li1": "[fr] The layer's opacity can be adjusted using the slider control.",
"li2": "[fr] If the layer has a bounding box, its visibility can be toggled using the checkbox.",
"li3": "[fr] If the layer is a feature layer, and is in on-demand mode, the option to Load All Features is available. On-demand mode means the layer will be downloaded in parts as needed. Clicking Load All Features will cause all layer data to be loaded in the browser at once, providing snappier response times once the download completes. This is called snapshot mode. Attempting this with very large datasets may cause the site to stall or the layer to crash. A layer in snapshot mode will have the Load All Features link disabled and a checkmark beside the link."
}
},
"s7": {
Expand Down

0 comments on commit 1381b83

Please sign in to comment.