Changeset 6805 for trunk/doc/src/docbook/user/annotations.xml

Timestamp:

Mar 26, 2015, 8:47:33 AM (7 years ago)

Author:

Nicklas Nordborg

Message:

References #1910: Disable annotation inheritance for annotation types

Updated documentation with some information about this (and about the older feature for disabling change log #1784).

File:

• trunk/doc/src/docbook/user/annotations.xml (modified) (1 diff)

trunk/doc/src/docbook/user/annotations.xml

@@ -222 +222 @@
         </varlistentry>
         <varlistentry>
+          <term><guilabel>Disable change log</guilabel></term>
+          <listitem>
+            <para>
+              If this option is checked, change history logging does not include the
+              actual old/new annotation values. Note that the log will still contain 
+              an entry that the annotation was modified. It is recomended that this
+              option is enabled for annotations containing sensitive data since
+              access permissions to the change history are different.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><guilabel>Disable inheritance</guilabel></term>
+          <listitem>
+            <para>
+              If this option is checked, annotations of this type are not allowed to be
+              inherited to other items. <nohelp>See <xref linkend="annotations.inheriting" /> 
+              for more information about inheritance.</nohelp> It is recomended that this
+              option is enabled for annotations containing sensitive data since
+              access permissions to inherited information may be different.
+            </para>
+            <warning>
+              <title>Existing inherited annotations are removed</title>
+              <para>
+                Be careful when enabling this option for an annotation type
+                if there are existing items that already inherit this annotation
+                type from their parents. The existing inheritance is automatically
+                dropped, and it will not be re-created if resetting this option
+                again.
+              </para>
+            </warning>
+            
+          </listitem>
+        </varlistentry>
+        <varlistentry>
           <term><guilabel>Description</guilabel></term>
           <listitem>