Skip to content

Commit

Permalink
update docs re: FileCategories setting
Browse files Browse the repository at this point in the history
  • Loading branch information
qqmyers committed May 2, 2023
1 parent 808df81 commit e928ff0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/release-notes/9204-group-by-file-ordering.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Dataverse now supports grouping dataset files by folder and/or optionally by Tag

### New Setting

:CategoryOrder - a comma separated list of Category/Tag names defining the order in which files with those tags should be displayed. The setting can include custom tag names along with the pre-defined Documentation, Data, and Code tags.
:CategoryOrder - a comma separated list of Category/Tag names defining the order in which files with those tags should be displayed. The setting can include custom tag names along with the pre-defined defaults ( Documentation, Data, and Code, which can be overridden by the ::FileCategories setting.)
:OrderByFolder - defaults to true - whether to group files in the same folder together
:AllowUserManagementOfOrder - default false - allow users to toggle ordering on/off in the dataset display
4 changes: 3 additions & 1 deletion doc/sphinx-guides/source/installation/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3710,6 +3710,8 @@ For example:

When set to ``true``, this setting allows a superuser to publish and/or update Dataverse collections and datasets bypassing the external validation checks (specified by the settings above). In an event where an external script is reporting validation failures that appear to be in error, this option gives an admin with superuser privileges a quick way to publish the dataset or update a collection for the user.

.. _:FileCategories:

:FileCategories
+++++++++++++++

Expand Down Expand Up @@ -3815,7 +3817,7 @@ To use the current GDCC version directly:
++++++++++++++

A comma separated list of Category/Tag names defining the order in which files with those tags should be displayed.
The setting can include custom tag names along with the pre-defined Documentation, Data, and Code tags.
The setting can include custom tag names along with the pre-defined tags(Documentation, Data, and Code are the defaults but the :ref:`:FileCategories` setting can be used to use a different set of tags).
The default is category ordering disabled.

:OrderByFolder
Expand Down

0 comments on commit e928ff0

Please sign in to comment.