Skip to content

Commit

Permalink
Doc/Config improvements
Browse files Browse the repository at this point in the history
Add clarification to configuration doc that list is space delimited and do the same for text_view formats
Remove type in config example (image instead of text)
Add sample configs for text_view and image_view
  • Loading branch information
mattfullerton committed Jan 2, 2017
1 parent e7913c3 commit 835a468
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
7 changes: 7 additions & 0 deletions ckan/config/deployment.ini_tmpl
Expand Up @@ -106,6 +106,13 @@ ckan.plugins = stats text_view image_view recline_view
# (plugins must be loaded in ckan.plugins)
ckan.views.default_views = image_view text_view recline_view

# Customize which text formats the text_view plugin will show
#ckan.preview.json_formats = json
#ckan.preview.xml_formats = xml rdf rdf+xml owl+xml atom rss
#ckan.preview.text_formats = text plain text/plain

# Customize which image formats the image_view plugin will show
#ckan.preview.image_formats = png jpeg jpg gif

## Front-End Settings
ckan.site_title = CKAN
Expand Down
10 changes: 5 additions & 5 deletions doc/maintaining/configuration.rst
Expand Up @@ -1186,7 +1186,7 @@ Example::

Default value: ``json``

JSON based resource formats that will be rendered by the Text view plugin (``text_view``)
Space-delimited list of JSON based resource formats that will be rendered by the Text view plugin (``text_view``)

.. _ckan.preview.xml_formats:

Expand All @@ -1199,7 +1199,7 @@ Example::

Default value: ``xml rdf rdf+xml owl+xml atom rss``

XML based resource formats that will be rendered by the Text view plugin (``text_view``)
Space-delimited list of XML based resource formats that will be rendered by the Text view plugin (``text_view``)

.. _ckan.preview.text_formats:

Expand All @@ -1212,7 +1212,7 @@ Example::

Default value: ``text plain text/plain``

Plain text based resource formats that will be rendered by the Text view plugin (``text_view``)
Space-delimited list of plain text based resource formats that will be rendered by the Text view plugin (``text_view``)

.. _ckan.preview.image_formats:

Expand All @@ -1221,11 +1221,11 @@ ckan.preview.image_formats

Example::

ckan.preview.text_formats = png jpeg jpg gif
ckan.preview.image_formats = png jpeg jpg gif

Default value: ``png jpeg jpg gif``

Image based resource formats that will be rendered by the Image view plugin (``image_view``)
Space-delimited list of image-based resource formats that will be rendered by the Image view plugin (``image_view``)

.. end_resource-views
Expand Down

0 comments on commit 835a468

Please sign in to comment.