Skip to content

Commit

Permalink
Improve list formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Rob Casey committed Sep 4, 2024
1 parent 0f25d4c commit 77424f4
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 50 deletions.
34 changes: 17 additions & 17 deletions docs/source/user-guide/guide_data_dictionaries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,23 +192,23 @@ We get a response that tells us the identifier for the new dictionary is `7fd6bb

Creating a data dictionary via the UI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1. Log in as a user with the *Data: Create new content* permission.
2. From the DKAN menu, select Data Dictionary -> Create.
3. Enter a human readable title for your data dictionary.
4. To define a "Data Dictionary field" start by clicking "Add field".
5. An "Add new field" editable form box will appear. Complete the required form fields here, reference the Table Schema section above if needed.
6. Click "Add" to save the field temporarily. Remember that the Data Dictionary and it's respective fields are not completely saved until the form is submitted in it's entirety by clicking "Save".
7. Alternatively you can click "Cancel" to stop creating the Data Dictionary field, at which point all the information you entered will be removed and the "Add new Field" box will close.
8. Note that after saving, an informational table will appear listing the data dictionary fields you have created thus far and their names, titles, and details (data types, formats and descriptions).

1. You also have the ability to edit or modify the data dictionary fields you've created so far by clicking the gear icon on the right-hand side of this table.
2. Clicking the gear icon will open an editable form that will show the previously entered information for the respective data dictionary field. You can then modify this information and either: save (retain the modifications), cancel (close the editable form box without retaining any modifications) or delete (remove the respective Data Dictionary field entirely).
9. You can enter any additional data dictionary fields by repeating steps 4-6.
10. Click the "Save" button.
11. See a list of your data dictionaries at `/api/1/metastore/schemas/data-dictionary/items/`
12. Edit your data dictionary by going to `/admin/dkan/data-dictionaries`.
13. Click the "Edit" link in the right-hand column next to the data dictionary you want to edit.
#. Log in as a user with the *Data: Create new content* permission.
#. From the DKAN menu, select Data Dictionary -> Create.
#. Enter a human readable title for your data dictionary.
#. To define a "Data Dictionary field" start by clicking "Add field".
#. An "Add new field" editable form box will appear. Complete the required form fields here, reference the Table Schema section above if needed.
#. Click "Add" to save the field temporarily. Remember that the Data Dictionary and it's respective fields are not completely saved until the form is submitted in it's entirety by clicking "Save".
#. Alternatively you can click "Cancel" to stop creating the Data Dictionary field, at which point all the information you entered will be removed and the "Add new Field" box will close.
#. Note that after saving, an informational table will appear listing the data dictionary fields you have created thus far and their names, titles, and details (data types, formats and descriptions).

#. You also have the ability to edit or modify the data dictionary fields you've created so far by clicking the gear icon on the right-hand side of this table.
#. Clicking the gear icon will open an editable form that will show the previously entered information for the respective data dictionary field. You can then modify this information and either: save (retain the modifications), cancel (close the editable form box without retaining any modifications) or delete (remove the respective Data Dictionary field entirely).

#. You can enter any additional data dictionary fields by repeating steps 4-6.
#. Click the "Save" button.
#. See a list of your data dictionaries at `/api/1/metastore/schemas/data-dictionary/items/`
#. Edit your data dictionary by going to `/admin/dkan/data-dictionaries`.
#. Click the "Edit" link in the right-hand column next to the data dictionary you want to edit.


Adding indexes
Expand Down
66 changes: 33 additions & 33 deletions docs/source/user-guide/guide_indexes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,57 +68,57 @@ The GUI can be used to create both Data Dictionary Fields and Indexes. See below

Prerequisites
^^^^^^^^^^^^^
1. Log in as an administrator.
2. From the DKAN menu, select Data Dictionary -> Create.
3. There are certain form elements that apply to all Data Dictionaries, they are as follows:
#. Log in as an administrator.
#. From the DKAN menu, select Data Dictionary -> Create.
#. There are certain form elements that apply to all Data Dictionaries, they are as follows:

1. Identifier: This is a UUID and is autogenerated for each Data Dictionary.
2. Title: Enter a name for your data dictionary here.
#. Identifier: This is a UUID and is autogenerated for each Data Dictionary.
#. Title: Enter a name for your data dictionary here.

4. After completing the above two required fields, move to the Data Dictionary Fields section and complete it, referencing :doc:`guide_data_dictionaries` if needed. Please note that any column you want to index below must be defined in the ‘Data Dictionary Fields’ section (see step 2.1 in the ‘Index Fields’ section below for reference).
5. After defining the fields, move to the ‘Indexes’ section.
#. After completing the above two required fields, move to the Data Dictionary Fields section and complete it, referencing :doc:`guide_data_dictionaries` if needed. Please note that any column you want to index below must be defined in the ‘Data Dictionary Fields’ section (see step 2.a in the ‘Index Fields’ section below for reference).
#. After defining the fields, move to the ‘Indexes’ section.

Indexes
^^^^^^^
1. Click "Add index".
2. An editable "Index" form box will appear. Complete the required form fields here:
#. Click "Add index".
#. An editable "Index" form box will appear. Complete the required form fields here:

1. Name: Enter a description of the index's purpose or functionality here.
2. Index Type:
#. Name: Enter a description of the index's purpose or functionality here.
#. Index Type:

1. index
2. fulltext
#. index
#. fulltext

3. After defining the index, move to the ‘Index Fields’ section. Please note that an index requires at least one index field and that index field must be defined in the ‘Data Dictionary Fields’ section.
#. After defining the index, move to the ‘Index Fields’ section. Please note that an index requires at least one index field and that index field must be defined in the ‘Data Dictionary Fields’ section.

Index Fields
^^^^^^^^^^^^
1. To add an index field, click "Add field" under the ‘Fields’ section within the respective ‘Index’ section.
2. An editable "Add new field" form box will appear. Complete the required form fields here:
#. To add an index field, click "Add field" under the ‘Fields’ section within the respective ‘Index’ section.
#. An editable "Add new field" form box will appear. Complete the required form fields here:

1. Name: Enter a name, this must be a key from the dictionary fields object as created previously (see step 4 in the ‘Prerequisites’ section above for reference).
2. Length: how many characters long this field can be.
#. Name: Enter a name, this must be a key from the dictionary fields object as created previously (see step 4 in the ‘Prerequisites’ section above for reference).
#. Length: how many characters long this field can be.

3. Click "Add" to save the field temporarily. Remember that the Data Dictionary and it's respective fields and indexes are not completely saved until the form is submitted by clicking "Save".
4. Alternatively you can click "Cancel" to stop creating the index field, at which point all the information you entered will be removed and the editable "Add new field" form box will close.
5. Note that after saving an index field, an informational table will appear listing the index fields you have created thus far and their names and length.
#. Click "Add" to save the field temporarily. Remember that the Data Dictionary and it's respective fields and indexes are not completely saved until the form is submitted by clicking "Save".
#. Alternatively you can click "Cancel" to stop creating the index field, at which point all the information you entered will be removed and the editable "Add new field" form box will close.
#. Note that after saving an index field, an informational table will appear listing the index fields you have created thus far and their names and length.

1. You also have the ability to edit or modify the fields you've created so far by clicking the gear icon on the right-hand side of this table.
2. Clicking the gear icon will open an editable form that will show the previously entered information for the respective index field. You can then modify this information and either: "Save Index Field" (retain the modifications), "Cancel Index Field" (close the editable form box without retaining any modifications) or "Delete Index Field" (remove the respective index field entirely).
#. You also have the ability to edit or modify the fields you've created so far by clicking the gear icon on the right-hand side of this table.
#. Clicking the gear icon will open an editable form that will show the previously entered information for the respective index field. You can then modify this information and either: "Save Index Field" (retain the modifications), "Cancel Index Field" (close the editable form box without retaining any modifications) or "Delete Index Field" (remove the respective index field entirely).

6. You can enter additional index fields by clicking "Add field" (in this index section) again and repeating steps 2-3.
7. After defining the index fields, click "Submit Index" to save the index temporarily. Remember that the Data Dictionary and it's respective fields and indexes are not completely saved until the form is submitted by clicking "Save".
8. Note that after submitting, an informational table will appear listing the indexes you have created thus far and their names, types, and fields (field name and field length).
#. You can enter additional index fields by clicking "Add field" (in this index section) again and repeating steps 2-3.
#. After defining the index fields, click "Submit Index" to save the index temporarily. Remember that the Data Dictionary and it's respective fields and indexes are not completely saved until the form is submitted by clicking "Save".
#. Note that after submitting, an informational table will appear listing the indexes you have created thus far and their names, types, and fields (field name and field length).

1. You also have the ability to edit or modify the indexes you've created so far by clicking the gear icon on the right-hand side of this table.
2. Clicking the gear icon will open an editable form that will show the previously entered information for the respective index. You can then modify this information and either: "Save" (retain the modifications), "Cancel Index" (close the editable form box without retaining any modifications) or "Delete Index" (remove the respective index entirely).
#. You also have the ability to edit or modify the indexes you've created so far by clicking the gear icon on the right-hand side of this table.
#. Clicking the gear icon will open an editable form that will show the previously entered information for the respective index. You can then modify this information and either: "Save" (retain the modifications), "Cancel Index" (close the editable form box without retaining any modifications) or "Delete Index" (remove the respective index entirely).

1. Note here that it is not possible to modify index fields in this manner at this time. If you must change an index field, the current work around is to delete the associated index entirely and re-create it and it's fields again.
#. Note here that it is not possible to modify index fields in this manner at this time. If you must change an index field, the current work around is to delete the associated index entirely and re-create it and it's fields again.

9. Finally, make sure you click "Save" and then "Yes" to "Are you sure you want to publish this item?" in order to submit the form in it's entirety, saving the data dictionary.
10. See a list of your data dictionaries at `/api/1/metastore/schemas/data-dictionary/items/`
11. Edit your data dictionary by going to `/admin/dkan/data-dictionaries`.
12. Click the "Edit" link in the right-hand column next to the data dictionary you want to edit.
#. Finally, make sure you click "Save" and then "Yes" to "Are you sure you want to publish this item?" in order to submit the form in it's entirety, saving the data dictionary.
#. See a list of your data dictionaries at `/api/1/metastore/schemas/data-dictionary/items/`
#. Edit your data dictionary by going to `/admin/dkan/data-dictionaries`.
#. Click the "Edit" link in the right-hand column next to the data dictionary you want to edit.



0 comments on commit 77424f4

Please sign in to comment.