Documentation about text templates improved

dkratzert · Nov 26, 2023 · b1066b0 · b1066b0
1 parent 85b3d9f
commit b1066b0
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/docs/description.rst b/docs/description.rst
@@ -48,6 +48,7 @@ other programs like ShelXle.
 
 **Files used by FinalCif**
 
+For CIF files from Bruker data, FinalCif needs the following files in the same folder as the CIF file:
 * SADBABS .abs
 * SAINT _0m._ls, _01._ls
 * Bruker _0m.p4p

diff --git a/docs/templates.rst b/docs/templates.rst
@@ -5,20 +5,21 @@ FinalCif uses three different kinds of templates to simplify recurring tasks:
 
 * Large text templates
     Each editable text field in the main table can hold text snippets as templates for reoccurring texts.
-    The text template editor opens with a right-click on "Text Template" in the main table.
-    This opens a new page where the first line shows the CIF key from the row of the previous mouse click.
-    In the large text field below, you can type any text and apply it with the "Apply Text" button,
-    or you compose any kind of text snippets in the input fields below.
+    The text template editor opens with the tiny 'edit' button that appears as long as the mouse cursor
+    hovers over the field. Also a right-click in the main table on "Text Template" opens the editor.
+    The editor is an a new page where the first line shows the CIF key from the row of the previous mouse click.
+    In the large text field right-below, you can type any text and apply it with the "Apply Text" button,
+    or you compose any kind of text snippets in the input fields left-below.
     These fields can be saved with the "Save as Template" button. A saved template is indicated with
-    light-blue background color in the respective edit field of the main table.
+    light-gray background color in the respective edit field of the main table.
 
 .. figure:: pics/text_templates.png
    :width: 700
 
 The template editor for large text snippets.
 
-    After you saved something as template, it will be loaded again on the next "Text Template"
-    click on this same CIF key row. The trick here is that you can click the checkboxes before
+    After you saved something as template, it will be loaded again if the editor is opened again
+    on this same CIF key row. The trick here is that you can click the checkboxes before
     each text snippet to append the text of it to the "combined Text" field in click order.
     As any other templates in FinalCif, you can export/import them to CIF files.
     "Delete Template" deletes it from the configuration and will not show up again.
@@ -30,7 +31,7 @@ The template editor for large text snippets.
 
 * Equipment templates
     They are useful for definitions of parameters like the properties of a measurement device
-    or the name and address of the crystallographer. Apply template by double-clicking on one row.
+    or the name and address of the crystallographer. Apply template by double-clicking the respective row.
 
 .. figure:: pics/templates.png