diff --git a/doc/architecture.rst b/doc/architecture.rst index 7603d7fe851..64d2a56c831 100644 --- a/doc/architecture.rst +++ b/doc/architecture.rst @@ -179,13 +179,13 @@ See :doc:`test` for further information on testing in CKAN. Writing Extensions ------------------ -Please see :doc:`writing-extensions` for information about writing ckan +Please see :ref:`writing-extensions` for information about writing ckan extensions, including details on the API available to extensions. Deprecation ----------- -- Anything that may be used by extensions (see :doc:`writing-extensions`) needs +- Anything that may be used by extensions (see :ref:`writing-extensions`) needs to maintain backward compatibility at call-site. ie - template helper functions and functions defined in the plugins toolkit. diff --git a/doc/background-tasks.rst b/doc/background-tasks.rst index 89483b63414..799a0099754 100644 --- a/doc/background-tasks.rst +++ b/doc/background-tasks.rst @@ -7,7 +7,7 @@ Background Tasks CKAN allows you to create tasks that run in the 'background', that is asynchronously and without blocking the main application (these tasks can also be automatically retried in the case of transient failures). Such tasks can be -created in :doc:`Extensions ` or in core CKAN. +created in :ref:`Extensions ` or in core CKAN. Background tasks can be essential to providing certain kinds of functionality, for example: diff --git a/doc/extensions.rst b/doc/extensions.rst index 3cfa20a0b86..599c346af01 100644 --- a/doc/extensions.rst +++ b/doc/extensions.rst @@ -21,8 +21,8 @@ CKAN comes with several pre-installed extensions: * ``reclinepreview`` - Preview Google Documents, CSV files, Excel files, etc. via the Recline.js library * ``jsonpreview`` - Preview json files + * ``resourceproxy`` - Allow remotly hosted content to be viewed -* ``resourceproxy`` - ???? * ``stats`` - Show stats and visuals about your site's datasets @@ -35,6 +35,8 @@ for how to install and configure it. For a list of external extensions, see the `list of extensions the CKAN wiki `_. +.. _writing-extensions: + ================== Writing Extensions ================== diff --git a/doc/index.rst b/doc/index.rst index 304af6a5de3..78508a32cf7 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -40,7 +40,6 @@ Customizing and Extending resources apps-ideas extensions - writing-extensions toolkit tag-vocabularies form-integration @@ -48,8 +47,6 @@ Customizing and Extending filestore datastore background-tasks - harvesting - geospatial multilingual email-notifications tracking diff --git a/doc/tag-vocabularies.rst b/doc/tag-vocabularies.rst index 1c751045f2a..1d7d202a8f6 100644 --- a/doc/tag-vocabularies.rst +++ b/doc/tag-vocabularies.rst @@ -61,7 +61,7 @@ To add a tag vocabulary to a site, a CKAN sysadmin must: vocabulary and tags. See :doc:`api`. 2. Implement an ``IDatasetForm`` plugin to add a new field for the tag - vocabulary to the dataset schema. See :doc:`writing-extensions`. + vocabulary to the dataset schema. See :ref:`writing-extensions`. 3. Provide custom dataset templates to display the new field to users when adding, updating or viewing datasets in the CKAN web interface.