Skip to content

Commit

Permalink
[#520] Few more textual tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
johnmartin committed Apr 30, 2013
1 parent ad809c8 commit 66f4ada
Showing 1 changed file with 39 additions and 19 deletions.
58 changes: 39 additions & 19 deletions doc/theming.rst
Expand Up @@ -16,11 +16,35 @@ Here are the two main ways you can customize the appearance of CKAN:
Edit CKAN config options
------------------------

This method is best if you simply want to change the logo, title and perhaps
add a little custom CSS. When you login to CKAN as a sysadmin user, you'll see
a link to the Administration page where you can edit your CKAN config options.
This method is best if you simply want to change the logo, title, add a little
custom CSS and perhaps customize a few templates. There are two types of config
options you can set to customize your instance. You can set options within
your `CKAN config file`_ or edit your `Instance sysadmin settings`_.

Here are the basic config options you can change:
CKAN config file
~~~~~~~~~~~~~~~~

You can change both some of your front end settings and template settings from
within your CKAN config file.

If you wish to change the site title, description, logo, favicon, etc, then you
should consult the `CKAN Configuration Options > Front-End Settings`_
documentation.

If you wish add images, customize templates or add extra stylesheets then you
should read the `CKAN Configuration Options > Theming Settings`_ documentation.

.. Note::
If you are planning on customizing you CKAN instance beyond the settings
provided here it is recommended that you read the
`Create Custom Extension`_ documentation.

Instance sysadmin settings
~~~~~~~~~~~~~~~~~~~~~~~~~~

When you login to CKAN as a sysadmin user, you'll see a link to the
Administration page where you can edit your CKAN config options. Here are the
basic config options you can change on the Administation page:

- **Site Title:** This is the title of this CKAN instance. It appears in the page title and various other places throughout your CKAN instance.

Expand All @@ -34,12 +58,6 @@ Here are the basic config options you can change:

- **Custom CSS:** This is a block of CSS that appears in ``<head>`` tag of every page. If you wish to customize the templates more fully we recommend using the extension method of customizing your CKAN instance.

.. Note::
You can also change your ``site_title`` within your CKAN config file.
However changing the 'Site Title' within the ckan admin interface will
override this setting.


Create Custom Extension
-----------------------

Expand All @@ -59,16 +77,16 @@ has template inheritance which means that you don't have to re-write a whole
template in order to change small elements within templates.

For more information on how to exactly change the HTML of your CKAN instance:
please read the `Templating > CKAN Extensions`_ documentation.
please read the `Templating`_ documentation.


Including custom Stylesheets, JavaScript and images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Within CKAN we use a resource manager called `Fanstatic`_ to handle the static
resources that are required by any given template. In order to include a
stylesheet or a JavaScript document you should tell Fanstatic of its existence
and then include it within your template.
Within CKAN we use a resource manager to handle the static resources that are
required by any given template. In order to include a stylesheet or a
JavaScript document you should tell the resource manager of its existence and
then include it within your template.

For more information on how resources work within CKAN and how to add custom
resources to your extension: please read the
Expand All @@ -95,8 +113,8 @@ Customizing the CSS
~~~~~~~~~~~~~~~~~~~

To customize your CSS all you really need to know is how to add a stylesheet as
a fanstatic resource. Beyond that it's purely writing your own CSS and making
sure it's included on the correct pages.
a resource. Beyond that it's purely writing your own CSS and making sure it's
included on the correct pages.

For more information on how CSS works in CKAN core: please read the
`Front End Documentation > Stylesheets`_ documentation.
Expand All @@ -112,9 +130,11 @@ For more information on how CSS works in CKAN core: please read the
.. _Bootstrap: http://getbootstrap.com/
.. _Jinja2: http://Jinja2.pocoo.org/
.. _markdown: http://daringfireball.net/projects/markdown/
.. _Fanstatic: http://fanstatic.org/
.. _LESS: http://lesscss.org/
.. _Templating > CKAN Extensions: ./templating.html#ckan-extensions
.. _Templating: ./templating.html
.. _Resources > Resources within extensions: ./resources.html#resources-within-extensions
.. _Building a JavaScript Module: ./javascript-module-tutorial.html
.. _Front End Documentation > Stylesheets: ./frontend-development.html#stylesheets
.. _CKAN Configuration Options > Front-End Settings: ./configuration.html#front-end-settings
.. _CKAN Configuration Options > Theming Settings: ./configuration.html#theming-settings

0 comments on commit 66f4ada

Please sign in to comment.