Skip to content

Commit

Permalink
add links to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
julie-sullivan committed May 8, 2019
1 parent 018d545 commit ca44ccb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
14 changes: 6 additions & 8 deletions docs/webapp/permanent-url/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,19 @@ They are based on class names combined with local IDs provided by the data resou

In FlyMine, for example, the URL of the report page for the gene zen, with primary identifier P19107, will be http://flymine.org/gene:FBgn0004053.

They are used to share the report page with other users.
These URLs are used to share the report page with other users.

.. image:: img/share.png

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>
=============== ================
.. code-block:: property
<CLASSNAME>_URI <FIELDNAME>
The classes and fields are case sensitive.
The classes and field names are case sensitive.

For example:

Expand All @@ -33,6 +31,6 @@ Organism_URI taxonId
Publication_URI pubMedId
=============== ================

See :doc:`/webapp/properties/class-keys` for details.
See :doc:`/webapp/properties/class-keys` for details about this file.

.. index:: permanent URL
2 changes: 1 addition & 1 deletion docs/webapp/properties/class-keys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ Given the above configuration, in FlyMine, the URL of the report page for the pr

See :doc:`/webapp/permanent-url/index` for details on permanent URLs.

See FlyMine's class keys for an example.
See `FlyMine's class keys <https://github.com/intermine/flymine/blob/master/dbmodel/resources/class_keys.properties>`_ for an example file.

.. index:: class keys, list upload classes

0 comments on commit ca44ccb

Please sign in to comment.