Skip to content

Commit

Permalink
Merge branch 'master' of github.com:xgds/xgds_notes2
Browse files Browse the repository at this point in the history
  • Loading branch information
KhaledSharif committed Mar 24, 2019
2 parents c2f7aad + 399a90f commit 60a9713
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 28 deletions.
47 changes: 40 additions & 7 deletions xgds_notes2/static/xgds_notes2/help/editTags.rst
Original file line number Diff line number Diff line change
@@ -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*



Expand Down
22 changes: 13 additions & 9 deletions xgds_notes2/static/xgds_notes2/help/import.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
15 changes: 8 additions & 7 deletions xgds_notes2/static/xgds_notes2/help/recordSession.rst
Original file line number Diff line number Diff line change
@@ -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.



Expand Down
5 changes: 0 additions & 5 deletions xgds_notes2/static/xgds_notes2/js/tags_tree.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,11 +153,6 @@ $.extend(xgds_notes,{
xgds_notes.doSaveTag(mode, node);
}
},
position: {
my: 'left top',
at: 'right bottom',
of: start_position
},
dialogClass: 'saveAs'
});
},
Expand Down

0 comments on commit 60a9713

Please sign in to comment.