add links to docs

intermine · May 8, 2019 · 018d545 · 018d545
1 parent 4f6a738
commit 018d545
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 2 deletions.
diff --git a/docs/webapp/index.rst b/docs/webapp/index.rst
@@ -26,6 +26,7 @@ Guide to Customising your Web Application
     performance/index
     diagnostic/index
     javadoc/index
+    permanent-url/index
     iodocs
 
 Overwrite any JSP

diff --git a/docs/webapp/permanent-url/img/Untitled.xcf b/docs/webapp/permanent-url/img/Untitled.xcf
diff --git a/docs/webapp/permanent-url/index.rst b/docs/webapp/permanent-url/index.rst
@@ -11,8 +11,19 @@ They are used to share the report page with other users.
 
 .. image:: img/share.png
 
-The class_keys.properties file speficies the keys used to generate the permanent URLs.
-If not specified, the primaryidentifier key is used.
+The :doc:`class_keys.properties </webapp/properties/class-keys/>` file specifies the keys used to generate the permanent URLs. If not specified, the primaryidentifier key is used.
+
+The format is:
+
+=============== ================
+key             value
+=============== ================
+<CLASSNAME>_URI <FIELDNAME>
+=============== ================
+
+The classes and fields are case sensitive.
+
+For example:
 
 =============== ================
 key             value
@@ -22,5 +33,6 @@ Organism_URI    taxonId
 Publication_URI pubMedId
 =============== ================
 
+See :doc:`/webapp/properties/class-keys` for details.
 
 .. index:: permanent URL
diff --git a/docs/webapp/properties/class-keys.rst b/docs/webapp/properties/class-keys.rst
@@ -17,4 +17,8 @@ Publication_URI pubMedId
 
 Given the above configuration, in FlyMine, the URL of the report page for the protein ARRB_DROME, with UniProt accession P19107, will be http://flymine.org/protein:P19107.
 
+See :doc:`/webapp/permanent-url/index` for details on permanent URLs.
+
+See FlyMine's class keys for an example.
+
 .. index:: class keys, list upload classes