erratum - first pass

sphinx/tutorial/rose/metadata.rst

@@ -24,9 +24,10 @@ outside of the configuration.
 The :rose:file:`rose-meta.conf` file uses the standard 
 :ref:`Rose configuration format <tutorial-rose-configurations>`.
 
-The metadata for a setting is written in a section which is named after the ID
-of the setting which is the section and setting name separated by an equals
-symbol.
+The metadata for a setting is written in a section named ``section=setting``
+where ``setting`` is the name of the setting and ``section`` is the section to
+which the setting belongs (leave blank if the setting does not belong to
+a section).
 
 For example take the following application configuration.
 
@@ -39,7 +40,7 @@ For example take the following application configuration.
    [env]
    WORLD=Earth
 
-For example if we were to write metadata for ``WORLD`` environemt variable we
+If we were to write metadata for ``WORLD`` environment variable we
 would create a section called ``[env=WORLD]``.
 
 .. code-block:: rose
@@ -88,7 +89,7 @@ There are many metadata items, here are some of the commonly used ones:
    Specify the length of comma separated lists e.g. ``length=:`` for a
    limitless list.
 ``range``
-   Specify numberical bounds for the value of a setting e.g. ``range=1, 10``
+   Specify numerical bounds for the value of a setting e.g. ``range=1, 10``
    for a value between 1 and 10.
 
 For a full list of metadata items see :rose:conf:`rose-meta.conf[SETTING]`.
@@ -128,7 +129,7 @@ For a full list of metadata items see :rose:conf:`rose-meta.conf[SETTING]`.
       Hover the mouse over the hash to reveal the comment.
 
       Keep the :ref:`command-rose-config-edit` window open as we will use it
-      throught the rest of this practical.
+      throughout the rest of this practical.
 
    #. **Descriptions.**
 
@@ -166,11 +167,13 @@ For a full list of metadata items see :rose:conf:`rose-meta.conf[SETTING]`.
          rose metadata-check -C meta/
       
       Next reload the metadata in the :ref:`command-rose-config-edit` window
-      using the :menuselection:`Metadata -> Refresh Metadata` menu item.
+      using the :menuselection:`Metadata --> Refresh Metadata` menu item.
       The descriptions should now display under each environment variable.
 
-      If you don't see the description for a setting it is possible that you
-      miss-spelt the name of the setting in the section heading.
+      .. tip::
+
+         If you don't see the description for a setting it is possible that you
+         miss-spelt the name of the setting in the section heading.
 
    #. **Length.**
 
@@ -199,7 +202,7 @@ For a full list of metadata items see :rose:conf:`rose-meta.conf[SETTING]`.
          rose metadata-check -C meta/
 
       Refresh the metadata in the :ref:`command-rose-config-edit` window be
-      selecting :menuselection:`Metadata -> Refresh Metadata`.
+      selecting :menuselection:`Metadata --> Refresh Metadata`.
       The three settings we have edited should now appear as lists.
 
    #. **Types.**
@@ -222,6 +225,9 @@ For a full list of metadata items see :rose:conf:`rose-meta.conf[SETTING]`.
 
       Add similar ``type`` entries for the following settings:
 
+      .. note that :align: center does not work with the `table` directive
+         see https://github.com/sphinx-doc/sphinx/issues/3942
+
       ====================  =========================
       ``integer`` settings  ``real`` (float) settings
       ====================  =========================

sphinx/tutorial/rose/rosie.rst

@@ -20,17 +20,6 @@ Rosie:
    control see the `FCM User Guide`_.
 
 
-Version Control
----------------
-
-When a rose suite configuration is managed with Rosie the :term:`suite
-directory` is added to `version control`_ using `FCM`_.
-
-FCM is a `subversion <SVN>`_ (SVN) wrapper which provides a standard working
-practice for SVN projects. FCM implements all of the SVN commands as well as
-additional functionality. See the `FCM User Guide`_ for more information.
-
-
 Rosie Suites
 ------------
 
@@ -43,7 +32,18 @@ system. Rosie suites can be created by the command:
    Create a new suite or copy an existing one.
 
 By default Rosie creates the `working copy`_ (local copy) of new suites in the
-``~/roses`` directory though Rosie working coppies can be created elsewhere.
+``~/roses`` directory though Rosie working copies can be created elsewhere.
+
+
+Version Control
+---------------
+
+In Rosie suites the :term:`suite directory` is added to `version control`_
+using `FCM`_.
+
+FCM is a `subversion <SVN>`_ (SVN) wrapper which provides a standard working
+practice for SVN projects. FCM implements all of the SVN commands as well as
+additional functionality. See the `FCM User Guide`_ for more information.
 
 
 Suite Naming
@@ -56,15 +56,18 @@ hyphen and then an identifier made up of two characters and three numbers e.g:
    :align: center
 
    bgcolor = "none"
+   ranksep=0
+
    node [shape="plaintext", fontsize="11"]
    edge [style="invis"]
-   graph [ranksep=0]
+
    a1 [label="u", fontsize=20]
    a2 [label="Prefix", fontcolor="#707070"]
    b1 [label="-", fontsize=20]
    b2 [label="", fontcolor="#707070"]
    c1 [label="aa001", fontsize=20]
    c2 [label="Unique Identifier", fontcolor="#707070"]
+
    a1 -- a2
    b1 -- b2
    c1 -- c2
@@ -142,7 +145,7 @@ commands called :ref:`command-rosie-go`.
       to you.
 
       You can specify the repository to use with the ``--prefix`` command line
-      option. For instance to use the (internal) MetOffice Testing Repository
+      option. For instance to use the (internal) Met Office Testing Repository
       supply the command line argument ``--prefix=mot``.
 
       .. code-block:: sub

sphinx/tutorial/rose/suites.rst

@@ -23,9 +23,7 @@ A rose suite configuration is a cylc :term:`suite directory` containing a
 
 The :rose:file:`rose-suite.conf` file is written in the same
 :ref:`format <tutorial-rose-configurations>` as the :rose:file:`rose-app.conf`
-file. It is used to configure:
-
-Its main configuration sections are:
+file. Its main configuration sections are:
 
 :rose:conf:`rose-suite.conf[env]`
    Environment variables for use by the whole suite.
@@ -78,7 +76,7 @@ directory. As cylc runs suites in the ``cylc-run`` directory the
 in the same directory in which it is written.
 
 With Rose we develop suites in a separate directory to the one in which they
-run meaning that the :term:`suite directory` is separate from the
+run meaning that the :term:`suite directory` is different from the
 :term:`run directory`. This helps keep the suite separate from its output and
 means that you can safely work on a suite and its resources whilst it is
 running.