Revision 8263
Added by Lauren Walker over 11 years ago
configuration.rst | ||
---|---|---|
223 | 223 |
|
224 | 224 |
Skins Configuration |
225 | 225 |
~~~~~~~~~~~~~~~~~~~ |
226 |
Customizing the look and feel of Metacat's Web interface is done via skins, |
|
227 |
which are applied in the Skins Configuration section. If you have installed |
|
228 |
the optional Registry, which provides a Web interface for creating, editing, |
|
229 |
and submitting content to the Metacat, you can also choose which form fields |
|
226 |
Customizing the look and feel of Metacat's web interface is done via skins or |
|
227 |
MetacatUI themes, however as of Version 2.2.0, skins have been deprecated. |
|
228 |
Use MetacatUI themes instead. Themes can be deployed separately from the |
|
229 |
Metacat server allowing easier independent user interface customization. |
|
230 |
|
|
231 |
MetacatUI Themes |
|
232 |
................ |
|
233 |
Themes are applied in the Skins Configuration section. If you have installed |
|
234 |
the optional Registry, which provides a web interface for creating, editing, |
|
235 |
and submitting content to Metacat, you can also choose which form fields |
|
230 | 236 |
appear in that interface and which are required. Note that if you do not have |
231 |
a custom skin AND you are not using the Registry, you can simply save the
|
|
232 |
default configuration. |
|
237 |
a custom theme AND you are not using the Registry, you can simply save the
|
|
238 |
``metacatui`` default configuration.
|
|
233 | 239 |
|
240 |
To use the new MetacatUI theming system, select ``metacatui`` and click the |
|
241 |
``Make metacatui default`` radio button. Metacat will open a list of options |
|
242 |
that apply to the Registry interface. For more information about creating |
|
243 |
custom themes, see the section called :doc:`themes </Modifying and Creating Themes>`. |
|
244 |
|
|
245 |
.. figure:: images/screenshots/image070.png |
|
246 |
:align: center |
|
247 |
|
|
248 |
Configuring Metacat themes. |
|
249 |
|
|
250 |
Skins |
|
251 |
................ |
|
252 |
.. deprecated:2.2.0 |
|
253 |
Use themes instead |
|
254 |
|
|
234 | 255 |
If your Metacat has a customized skin, it will appear as a choice in the |
235 |
Skins Configuration settings (see below screenshot). You can create your own skins as
|
|
236 |
well. For more information about creating skins, please see the section called
|
|
237 |
`Creating a Custom Skin`_.
|
|
256 |
Skins Configuration settings (see below screenshot). Select the checkbox next
|
|
257 |
to your customized skin or and click the ``Make <skin_name> default`` radio button.
|
|
258 |
If you do not have a custom skin, select the ``default`` skin.
|
|
238 | 259 |
|
260 |
Once you have selected a skin, Metacat will open a list of options that apply to the Registry |
|
261 |
interface. For more information about creating skins, see the Creating a Custom Skin |
|
262 |
section in :doc:`themes </Modifying and Creating Themes>`. |
|
263 |
|
|
239 | 264 |
.. figure:: images/screenshots/image023.png |
240 | 265 |
:align: center |
241 | 266 |
|
242 | 267 |
Configuring Metacat skins. |
243 | 268 |
|
244 |
Select the checkbox next to your customized skin and click the |
|
269 |
Select the checkbox next to your customized skin or and click the
|
|
245 | 270 |
``Make <skin_name> default`` radio button. If you do not have a custom skin, |
246 | 271 |
select the ``default`` skin. Once you have selected a skin, Metacat will open |
247 | 272 |
a list of options that apply to the Registry interface. |
... | ... | |
408 | 433 |
Where ``<CONTEXT_DIR>`` is the directory in which the Metacat application code |
409 | 434 |
lives (described above) and ``<SKIN_NAME>`` is the name of the skin |
410 | 435 |
(e.g., ``default`` or ``nceas``). |
411 |
|
|
412 |
Creating a custom skin |
|
413 |
~~~~~~~~~~~~~~~~~~~~~~ |
|
414 |
Skins are used in Metacat to customize the appearance of the search and display |
|
415 |
web interface that is presented by Metacat. Skins can be used to make a Metacat |
|
416 |
instance exactly integrate into an existing web site, and are fully customizable. |
|
417 |
|
|
418 |
To create and customize your own Metacat skin, you must first create a skin |
|
419 |
directory. This is most easily accomplished by copying one of the existing skin |
|
420 |
directories. Step-by-step directions for creating and installing a custom skin |
|
421 |
are included below: |
|
422 |
|
|
423 |
1. Copy an exisiting skin directory. We recommend using the "default" directory. |
|
424 |
|
|
425 |
:: |
|
426 |
|
|
427 |
sudo cp -r <CONTEXT_DIR>/style/skins/default/ <CONTEXT_DIR>/style/skins/[yourSkin]/ |
|
428 |
|
|
429 |
Where ``<CONTEXT_DIR>`` is the directory in which the Metacat application |
|
430 |
code lives and ``[yourSkin]`` is the name you wish to apply to your skin. |
|
431 |
|
|
432 |
2. In ``[yourSkin]`` directory, change all files named ``default.xxx`` to |
|
433 |
``yourSkin.xxx``. The following files should be changed: |
|
434 |
|
|
435 |
:: |
|
436 |
|
|
437 |
default.css |
|
438 |
default.js |
|
439 |
default.properties |
|
440 |
default.properties.metadata.xml |
|
441 |
default.xml |
|
442 |
|
|
443 |
3. In the metacat.properties file(``<CONTEXT_DIR>/WEB_INF/metacat.properties``), |
|
444 |
add ``[yourSkin]`` to the value of the skin.names property. |
|
445 |
|
|
446 |
4. Restart Tomcat. Log in as the user that runs your Tomcat server (often "tomcat") and type: |
|
447 |
|
|
448 |
:: |
|
449 |
|
|
450 |
/etc/init.d/tomcat6 restart |
|
451 |
|
|
452 |
Navigate to Metacat's Configuration utility and select the Configure Skins |
|
453 |
option. Your custom skin should appear as a choice in the skins list. Change |
|
454 |
the layout and style by modifying the header, footer, css, and other files in |
|
455 |
your new skin directory. |
|
456 |
|
|
457 |
It is important to note that all customized skins will be overwritten when |
|
458 |
Metacat is reinstalled or upgraded. Please remember to back up your skins before |
|
459 |
reinstalling or upgrading Metacat. |
Also available in: Unified diff
Added the documentation for the new MetacatUI theming mechanism. Make some styling changes to the documentation and configuration pages and added Bootstrap and FontAwesome.