From 90deb515fb203d965cf5d0ef0601c515da9f87ba Mon Sep 17 00:00:00 2001 From: Tamar Cohen Date: Fri, 22 Mar 2019 10:57:21 -0700 Subject: [PATCH 1/2] working on help --- .../static/xgds_notes2/help/editTags.rst | 47 ++++++++++++++++--- .../static/xgds_notes2/help/recordSession.rst | 15 +++--- .../static/xgds_notes2/js/tags_tree.js | 5 -- 3 files changed, 48 insertions(+), 19 deletions(-) diff --git a/xgds_notes2/static/xgds_notes2/help/editTags.rst b/xgds_notes2/static/xgds_notes2/help/editTags.rst index 7385a80..c16cf72 100644 --- a/xgds_notes2/static/xgds_notes2/help/editTags.rst +++ b/xgds_notes2/static/xgds_notes2/help/editTags.rst @@ -1,16 +1,49 @@ -**Edit Tags** lets you add TODO. +**Edit Tags** lets you add, delete, edit and organize tags. -Part A: ---------------------- +Exploring Tags: +--------------- -TODO write help +Tags are a key part of using the {{ settings.XGDS_NOTES_MONIKER }} to identify and search for data. It is important to have +meaningful, well organized, uniquely named tags that you and your team agree upon. Tags help prevent misspellings and differing abbreviations. +*Root tags* are tags that have no parent. -Part B: ------------------ + * To check if a tag exists, start typing the tag in the input box that says 'Type to check tag'. If it does not exist, it will say 'Tag not found'. + * To explore the tree, click the triangle on the left hand side to expand a tag and see its descendants + * If others are editing tags at the same time, click the reload button on the upper left to reload the tags. -TODO write more help +Adding Tags: +------------ + * Right click on the parent tag and choose *Add* from the popup menu + * A popup will appear. Enter an abbreviation, tag name and optional description and press *Save* + * You will see the new tag nested under the parent tag + * You cannot make multiple tags with the same name + * To add a *Root tag*, click on the *+ Root Tag* button at the top and follow the same process. +Editing Tags: +------------- + * Right click on the tag you wish to edit and choose *Edit* from the popup menu + * A popup will appear with that tag loaded. Modify the abbreviation, tag name and optional description and press *Save* + * You will see the changes in the tree + * You cannot make multiple tags with the same name + * If this tag has been used, all references will now instead use the new information that you have edited + +Deleting Tags: +-------------- + * Right click on the tag you wish to delete and select delete + * If the tag has not been used it will be deleted. + * If it has been used it cannot be deleted. You may edit it to make it more useful, or contact xGDS staff for help. + * If the tag has children, you must delete or reorganize the children before deleting the tag. + +Reorganizing Tags: +------------------ +The hierarchy (nesting) of tags allows you to search by a parent tag for all descendant tags. + + * Click on the tag you want to move + * Drag it over the new tag you want to contain it + * If that is a valid choice, you will see blue and green arrows and a checkmark. Release the mouse. + * If that is an invalid choice, you will see a red circle with a slash through it + * To turn a tag into a root tag, right click on it and select *Make Root* diff --git a/xgds_notes2/static/xgds_notes2/help/recordSession.rst b/xgds_notes2/static/xgds_notes2/help/recordSession.rst index e63c211..bfd75fd 100644 --- a/xgds_notes2/static/xgds_notes2/help/recordSession.rst +++ b/xgds_notes2/static/xgds_notes2/help/recordSession.rst @@ -1,15 +1,16 @@ -**Record Session** lets you TODO. +**Record Session** lets you modify your role and location for recording {{ settings.XGDS_NOTES_MONIKER }}. -Part A: ---------------------- +Modifying Role and Location: +---------------------------- -TODO write help +Role and location are very important to store where you were and what role you were in at the time of recording {{ settings.XGDS_NOTES_MONIKER }}s. -Part B: ------------------ + * If you have already set a role and location since logging in, they will be selected in the dropdowns + * Select the correct role and location + * Press Save -TODO write more help +Once you have set this, it will stick until you log out or quit your web browser. diff --git a/xgds_notes2/static/xgds_notes2/js/tags_tree.js b/xgds_notes2/static/xgds_notes2/js/tags_tree.js index ffff25e..215ba37 100644 --- a/xgds_notes2/static/xgds_notes2/js/tags_tree.js +++ b/xgds_notes2/static/xgds_notes2/js/tags_tree.js @@ -153,11 +153,6 @@ $.extend(xgds_notes,{ xgds_notes.doSaveTag(mode, node); } }, - position: { - my: 'left top', - at: 'right bottom', - of: start_position - }, dialogClass: 'saveAs' }); }, From 399a90f8b6d3457f814d1888023ec89633f6000e Mon Sep 17 00:00:00 2001 From: Tamar Cohen Date: Fri, 22 Mar 2019 11:55:43 -0700 Subject: [PATCH 2/2] import notes help --- .../static/xgds_notes2/help/import.rst | 22 +++++++++++-------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/xgds_notes2/static/xgds_notes2/help/import.rst b/xgds_notes2/static/xgds_notes2/help/import.rst index 607e499..0e1e5ec 100644 --- a/xgds_notes2/static/xgds_notes2/help/import.rst +++ b/xgds_notes2/static/xgds_notes2/help/import.rst @@ -1,18 +1,22 @@ -**Import Notes** lets you add TODO. +**Import {{settings.XGDS_NOTES_MONIKER}}** lets you import {{settings.XGDS_NOTES_MONIKER}}s from CSV files -Part A: ---------------------- +Download template: +------------------ -TODO write help - -Part B: ------------------ - -TODO write more help +Prepare for importing {{settings.XGDS_NOTES_MONIKER}}s by downloading a template similar to what you want to import. +You can import with or without tags, and for multiple users or for yourself. +Import {{settings.XGDS_NOTES_MONIKER}}s: +---------------------------------------- +Once you have populated the CSV template with the notes you want to import, use the form on the bottom of the page. + * Select the vehicle which will provide the location for each of the {{settings.XGDS_NOTES_MONIKER}}s based on the times + * Select the timezone in which you have specified the time in the CSV file you are importing + * Choose the CSV file to import + * Press the *Import* button +Your {{settings.XGDS_NOTES_MONIKER}}s should be imported and you can search for them as usual. .. o __BEGIN_LICENSE__ .. o Copyright (c) 2015, United States Government, as represented by the