Various change to indexing

This is all not yet cooked, but trying to be more consistent.

docs/basics/101-101-create.rst

@@ -19,7 +19,7 @@ useful features.
 Because experiencing is more insightful than just reading, we will explore the
 concepts of DataLad datasets together by creating one.
 
-.. index:: ! datalad command; create
+.. index:: ! DataLad command; create
 
 Find a nice place on your computer's file system to put a dataset for ``DataLad-101``,
 and create a fresh, empty dataset with the :dlcmd:`create` command.

docs/basics/101-102-populate.rst

@@ -100,7 +100,7 @@ structure with tree:
 
    $ tree
 
-.. index:: ! datalad command; status
+.. index:: ! DataLad command; status
 
 Now what does DataLad do with this new content? One command you will use very
 often is :dlcmd:`status`.
@@ -115,7 +115,7 @@ regular status reports should become a habit in the wake of ``DataLad-101``.
 
    $ datalad status
 
-.. index:: ! datalad command; save
+.. index:: ! DataLad command; save
 
 Interesting; the ``books/`` directory is "untracked". Remember how content
 *can* be tracked *if a user wants to*?

docs/basics/101-105-install.rst

@@ -1,4 +1,4 @@
-.. index:: ! datalad command; clone
+.. index:: ! DataLad command; clone
 .. _installds:
 
 Install datasets
@@ -55,7 +55,7 @@ called recordings.
    $ mkdir recordings
 
 
-.. index:: ! datalad command; clone
+.. index:: ! DataLad command; clone
 
 The command that can be used to obtain a dataset is :dlcmd:`clone`,
 but we often refer to the process of cloning a Dataset as *installing*.
@@ -234,7 +234,7 @@ hard drive has much space left...
 But you nevertheless are curious on how to actually listen to one of these ``.mp3``\s now.
 So how does one actually "get" the files?
 
-.. index:: ! datalad command; get
+.. index:: ! DataLad command; get
 
 The command to retrieve file content is :dlcmd:`get`.
 You can specify one or more specific files, or ``get`` all of the dataset by
@@ -311,7 +311,7 @@ of file contents in dataset, too?", they ask. "Yes", the lecturer responds,
 "you can remove file contents by using :dlcmd:`drop`. This is
 really helpful to save disk space for data you can easily re-obtain, for example".
 
-.. index:: datalad command; drop
+.. index:: DataLad command; drop
 
 The :dlcmd:`drop` command will remove
 file contents completely from your dataset.

docs/basics/101-106-nesting.rst

@@ -1,10 +1,10 @@
+.. index:: ! DataLad dataset; nesting
+
 .. _nesting:
 
 Dataset nesting
 ---------------
 
-.. index:: ! nesting
-
 Without noticing, the previous section demonstrated another core principle
 and feature of DataLad datasets: *Nesting*.
 

docs/basics/101-107-summary.rst

@@ -48,7 +48,7 @@ and making simple modifications *locally*.
 Furthermore, we have discovered the basics of installing a published DataLad dataset,
 and experienced the concept of modular nesting datasets.
 
-.. index:: ! datalad command; clone
+.. index:: ! DataLad command; clone
 
 * A published dataset can be installed with the :dlcmd:`clone` command:
 

docs/basics/101-108-run.rst

@@ -152,7 +152,7 @@ in a bit of time, we will forget how this file came into existence, or
 that the script ``code/list_titles.sh`` is associated with this file, and
 can be used to update it later on.
 
-.. index:: ! datalad command; run
+.. index:: ! DataLad command; run
 
 The :dlcmd:`run` command
 can help with this. Put simply, it records a command's impact on a dataset. Put

docs/basics/101-109-rerun.rst

@@ -3,7 +3,7 @@
 DataLad, re-run!
 ----------------
 
-.. index:: ! datalad command; rerun
+.. index:: ! DataLad command; rerun
 
 So far, you created a ``.tsv`` file of all
 speakers and talk titles in the ``longnow/`` podcasts subdataset.
@@ -158,7 +158,7 @@ we can see that a new :dlcmd:`run` was recorded. This action is
 committed by DataLad under the original commit message of the ``run``
 command, and looks just like the previous :dlcmd:`run` commit.
 
-.. index:: ! datalad command; diff
+.. index:: ! DataLad command; diff
 
 Two cool tools that go beyond the :gitcmd:`log`
 are the :dlcmd:`diff` and :gitcmd:`diff` commands.

docs/basics/101-110-run2.rst

@@ -231,7 +231,7 @@ In the attempt to resize the image to 450x450 you tried to overwrite
 ``recordings/salt_logo_small.jpg``, a file that was given to DataLad
 and thus protected by git-annex.
 
-.. index:: ! datalad command; unlock
+.. index:: ! DataLad command; unlock
 
 There is a DataLad command that takes care of unlocking file content,
 and thus making locked files modifiable again: :dlcmd:`unlock`.
@@ -504,4 +504,4 @@ Apart from displaying the command that will be ran, you will learn *where* the c
 
 .. [#f1] In shell programming, commands exit with a specific code that indicates
     whether they failed, and if so, how. Successful commands have the exit code zero. All failures
-    have exit codes greater than zero.
+    have exit codes greater than zero.

docs/basics/101-115-symlinks.rst

@@ -271,11 +271,11 @@ to manage the file system in a DataLad dataset (:ref:`filesystem`).
    Maybe you are as amazed as we are about some of the ingenuity used behind the scenes.
    Even more mesmerizing things about git-annex can be found in its `documentation <https://git-annex.branchable.com/git-annex>`_.
 
+.. index:: ! broken symlink, ! symlink; broken
+
 Broken symlinks
 ^^^^^^^^^^^^^^^
 
-.. index:: ! broken symlink, ! symlink (broken)
-
 Whenever a symlink points to a non-existent target, this symlink is called
 *broken*, and opening the symlink would not work as it does not resolve. The
 section :ref:`filesystem` will give a thorough demonstration of how symlinks can

docs/basics/101-116-sharelocal.rst

@@ -81,7 +81,7 @@ home directory. Furthermore, let's for now disregard anything about
 :term:`permissions`. In a real-world example you likely would not be able to read and write
 to a different user's directories, but we will talk about permissions later.
 
-.. index:: ! datalad command; clone
+.. index:: ! DataLad command; clone
 
 After creation, navigate into ``mock_user`` and install the dataset ``DataLad-101``.
 To do this, use :dlcmd:`clone`, and provide a path to your original
@@ -134,7 +134,7 @@ object tree. To reassure your room mate that everything is fine you
 quickly explain to him the concept of a symlink and the :term:`object-tree`
 of :term:`git-annex`.
 
-.. index:: ! datalad command; clone
+.. index:: ! DataLad command; clone
 
 "But why does the PDF not open when I try to open it?" he repeats.
 True, these files cannot be opened. This mimics our experience when

docs/basics/101-119-sharelocal4.rst

@@ -50,7 +50,7 @@ it can query the original dataset whether any changes
 happened since the last time it checked, and if so, retrieve and
 integrate them.
 
-.. index:: ! datalad command; update
+.. index:: ! DataLad command; update
 
 This is done with the :dlcmd:`update --how merge`
 command.

docs/basics/101-121-siblings.rst

@@ -97,7 +97,7 @@ dataset in our own, original dataset.
 
 Let's see how this is done.
 
-.. index:: ! datalad command; siblings
+.. index:: ! DataLad command; siblings
 
 First of all, navigate back into the original dataset.
 In the original dataset, "add" a "sibling" by using

docs/basics/101-122-config.rst

@@ -42,7 +42,7 @@ was surprisingly captivating, so you're actually looking forward to today.
 you did, already before the course started: The *global*
 Git configuration." the lecturer says.
 
-.. index:: ! git config
+.. index:: ! Git command; config
 
 At one point in time, you likely followed instructions such as
 in :ref:`install` and configured your

docs/basics/101-124-procedures.rst

@@ -85,7 +85,7 @@ spares naive users the necessity to learn about the ``.gitattributes``
 file when setting up a dataset.
 
 
-.. index:: ! datalad command; run-procedure
+.. index:: ! DataLad command; run-procedure
 
 
 To find out available procedures, the command

docs/basics/101-130-yodaproject.rst

@@ -256,7 +256,7 @@ you use the ``cfg_yoda`` procedure to help you structure the dataset [#f1]_:
    # inside of DataLad-101
    $ datalad create -c yoda --dataset . midterm_project
 
-.. index:: ! datalad command; datalad subdatasets
+.. index:: ! DataLad command; datalad subdatasets
 
 The :dlcmd:`subdatasets` command can report on which subdatasets exist for
 ``DataLad-101``. This helps you verify that the command succeeded and the
@@ -594,7 +594,7 @@ reason why the ``README.md`` in the root of the dataset was easily modifiable.
 
 .. find-out-more:: Saving contents with Git regardless of configuration with --to-git
 
-   .. index:: ! datalad command; save --to-git
+   .. index:: ! DataLad command; save --to-git
 
    The ``yoda`` procedure in ``midterm_project`` applied a different configuration
    within ``.gitattributes`` than the ``text2git`` procedure did in ``DataLad-101``.
@@ -647,7 +647,7 @@ syllabus, this should be done via :term:`GitHub`.
    .. image:: ../artwork/src/screenshot_submodule.png
       :alt: The input dataset is linked
 
-.. index:: ! datalad command; create-sibling-github
+.. index:: ! DataLad command; create-sibling-github
 .. _publishtogithub:
 
 Publishing the dataset to GitHub
@@ -660,7 +660,7 @@ For this, you need to
 - configure this GitHub repository to be a :term:`sibling` of the ``midterm_project`` dataset,
 - and *publish* your dataset to GitHub.
 
-.. index:: ! datalad command; create-sibling-gitlab
+.. index:: ! DataLad command; create-sibling-gitlab
 
 Luckily, DataLad can make this very easy with the
 :dlcmd:`create-sibling-github`
@@ -720,7 +720,7 @@ Verify that this worked by listing the siblings of the dataset:
    :dlcmd:`push` to this sibling, your datasets history
    will be pushed there.
 
-   .. index:: ! datalad command; push
+   .. index:: ! DataLad command; push
 
 On GitHub, you will see a new, empty repository with the name
 ``midtermproject``. However, the repository does not yet contain

docs/basics/101-132-advancednesting.rst

@@ -1,10 +1,10 @@
 .. _nesting2:
 
+.. index:: ! DataLad dataset; nesting
+
 More on dataset nesting
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-.. index:: ! nesting
-
 You may have noticed how working in the subdataset felt as if you would be
 working in an independent dataset -- there was no information or influence at
 all from the top-level ``DataLad-101`` superdataset, and you build up a

docs/basics/101-133-containersrun.rst

@@ -119,8 +119,8 @@ Singularity (even without having Docker installed).
 Using ``datalad containers``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. index:: ! datalad command; containers-add
-.. index:: ! datalad command; containers-run
+.. index:: ! DataLad command; containers-add
+.. index:: ! DataLad command; containers-run
 
 One core feature of the ``datalad containers`` extension is that it registers
 computational containers to a dataset. This is done with the
@@ -309,8 +309,8 @@ The complete command's structure looks like this:
 
    $ datalad containers-run --name <containername> [-m ...] [--input ...] [--output ...] <COMMAND>
 
-.. index:: ! datalad command; containers-remove
-.. index:: ! datalad command; containers-list
+.. index:: ! DataLad command; containers-remove
+.. index:: ! DataLad command; containers-list
 
 .. find-out-more:: How can I list available containers or remove them?
 

docs/basics/101-135-help.rst

@@ -45,7 +45,7 @@ To find out which version you are using, run
 
    $ datalad --version
 
-.. index:: ! datalad command; wtf
+.. index:: ! DataLad command; wtf
 
 If you want a comprehensive overview of your full setup,
 :dlcmd:`wtf` [#f1]_ is the command to turn to. Running this command will

docs/basics/101-136-filesystem.rst

@@ -986,7 +986,7 @@ the symlink is removed, but the content is retained in the history.
 Removing annexed content entirely
 """""""""""""""""""""""""""""""""
 
-.. index:: ! datalad command; drop
+.. index:: ! DataLad command; drop
 
 The command to remove file content entirely and irreversibly from a repository is
 the :dlcmd:`drop` command.
@@ -1104,7 +1104,7 @@ shows an example invocation.
 Uninstalling or deleting subdatasets
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. index:: ! datalad command; uninstall
+.. index:: ! DataLad command; uninstall
 
 Depending on the exact aim, different commands are of relevance for
 deleting a DataLad subdataset. The softer (and not so much "deleting" version)
@@ -1142,7 +1142,7 @@ To uninstall the dataset, you can use
 Note that the dataset is still known in the dataset, and not completely removed.
 A ``datalad get [-n/--no-data] cloud`` would install the dataset again.
 
-.. index:: ! datalad command; remove
+.. index:: ! DataLad command; remove
 
 In case one wants to fully delete a subdataset from a dataset, the
 :dlcmd:`remove` command is relevant [#f3]_.

docs/basics/101-139-dropbox.rst

@@ -159,7 +159,7 @@ be managed and accessed via DataLad/git-annex.
 To actually share your dataset with someone, you need to *publish* it to Github,
 Gitlab, or a similar hosting service.
 
-.. index:: ! datalad command; create-sibling-github
+.. index:: ! DataLad command; create-sibling-github
 
 You could, for example, create a sibling of the ``DataLad-101`` dataset
 on GitHub with the command :dlcmd:`create-sibling-github`.

docs/basics/101-139-gin.rst

@@ -47,7 +47,7 @@ You should copy the contents of your public key file into the field labeled
 Publishing your dataset to GIN
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. index:: ! datalad command; create-sibling-gin
+.. index:: ! DataLad command; create-sibling-gin
 
 As outlined in the section :ref:`share_hostingservice`, there are two ways in which you can publish your dataset to Gin.
 Either by 1) creating a new, empty repository on GIN via the web interface, or 2) via the :dlcmd:`create-sibling-gin` command.
@@ -120,7 +120,7 @@ repository's ``https`` url. This does not require a user account on Gin.
 
 .. importantnote:: Take the URL in the browser, not the copy-paste URL
 
-   .. index:: ! datalad command; clone
+   .. index:: ! DataLad command; clone
 
    Please note that you need to use the browser URL of the repository, not the copy-paste URL on the upper right hand side of the repository if you want to get anonymous HTTPS access!
    The two URLs differ only by a ``.git`` extension:
@@ -139,7 +139,7 @@ repository's ``https`` url. This does not require a user account on Gin.
 Subsequently, :dlcmd:`get` calls will be able to retrieve all annexed
 file contents that have been published to the repository.
 
-.. index:: ! datalad command; clone
+.. index:: ! DataLad command; clone
 
 If it is a **private** dataset, cloning the dataset from Gin requires a user
 name and password for anyone you want to share your dataset with.

docs/basics/101-141-push.rst

@@ -27,9 +27,9 @@ or storage of datasets [#f1]_, or a regular clone.
 
 .. find-out-more:: all of the ways to configure siblings
 
-   .. index:: ! datalad command; create-sibling-github
-   .. index:: ! datalad command; create-sibling-gitlab
-   .. index:: ! datalad command; create-sibling-ria
+   .. index:: ! DataLad command; create-sibling-github
+   .. index:: ! DataLad command; create-sibling-gitlab
+   .. index:: ! DataLad command; create-sibling-ria
 
    - Add an existing repository as a sibling with the :dlcmd:`siblings`
      command. Here are common examples:

docs/basics/101-146-gists.rst

@@ -163,7 +163,7 @@ Here is a one-liner to get this info:
 Backing-up datasets
 ^^^^^^^^^^^^^^^^^^^
 
-.. index:: ! datalad command; create-sibling
+.. index:: ! DataLad command; create-sibling
 
 In order to back-up datasets you can publish them to a
 :term:`Remote Indexed Archive (RIA) store` or to a sibling dataset. The former

docs/beyond_basics/101-145-hooks.rst

@@ -2,11 +2,11 @@
 .. _2-003:
 .. _hooks:
 
+.. index:: ! DataLad command; result hooks
+
 DataLad's result hooks
 ^^^^^^^^^^^^^^^^^^^^^^
 
-.. index:: ! result hooks, ! hooks
-
 If you are particularly keen on automating tasks in your datasets, you may be
 interested in running DataLad commands automatically as soon
 as previous commands are executed and resulted in particular outcomes or states.