| - WARNING: THIS ADMIN GUIDE IS NOT FULLY COMPLETED - | -
|---|
|
- This Admin Guide is not yet completed. Moreover, some
- admin-level functionality for this module exists only in the form of
- manual recipes. We are in the process of developing both the
- guide as well as the web admin interface. If you are interested
- in seeing some specific things implemented with high priority,
- please contact us at |
-
Version <: print generate_pretty_revision_date_string('$Id$'); :> - -
Guest users create a lot of entries in Version <: print generate_pretty_revision_date_string('$Id$'); :>
- This document describes how to change the look and feel of your CDS
-Invenio installation.
-
- The most obvious modification you may want to do is the
-modification of CSS style sheet.
-You may also customize default images. The customization of the general page look and feel is currently
-different depending on whether you customize HTML-like static pages
-(produced by WML during compile-time) or dynamic Python pages
-(assembled during runtime). (Note: this step will disappear in the future as we plan to release
-the dependency on WML in early 2007.) During the compile time, when you edit This will modify the look and feel of every WML-pregenerated page,
-such as HTML help guides. However, this will not affect most of the
-pages because they are generated in a dynamic way during runtime,
-without using WML. The dynamic Python-powered pages can be customized by making use of
-CDS Invenio templating system that uses a notion of a template skin.
-How this works? During the compile time, when you edit How do you create such an Let's show an example of how to modify the page footer. Create a
-file named After the file was created, restart Apache and lo, your new ithaca
-style footer will be seen in action. Some further remarks on this templating system: Bibliographic metadata is formatted using
-BibFormat. Read the
-BibFormat documentation
-for more information. Note that the search interface pages may be modified to a large
-extent in the WebSearch Admin
-Interface by adding HTML portalboxes on various places on the page
-(right top, before/after page title, before/after narrow by collection
-boxes, etc). The web pages displaying the details of a record (such as
- The content of these tabs can be customized on a collection basis. It
-is also possible to show/hide tabs depending on the displayed
-collection. The detailed record pages also feature a mini panel at the bottom of
-the page that links to popular functions (The mini panel is only
-displayed when Information tab is selected). The mini panel is only displayed when the Information tab is
-selected. It is divided into the following sections: The WebSearch admin web
-interface lets you decide for each collection which tabs are to be
-displayed. Choose a collection to edit in the collection tree and go
-to its detailed record page options. From there you can select which
-tabs to show for that collection. If you want to apply these settings to the subcollections, select
-Also apply to subcollections
-before you click on the
-
-button. Note that these settings only affect the tabs, not the content of the
-tabs: even if a tab is not displayed, it is still possible to access
-its content using its usual url. This is useful if you decide to
-completely change the detailed record pages, dropping the tab-metaphor
-(eg. for a side bar) but still want to access the comments, reviews,
-etc pages. Here are some behaviours you should expect when changing the tabs
-configuration: The contents of tabs are defined in the following ways: The content of the mini panel is defined in the following ways: You can customize how tabs look like, as well change the look of the
-border that surrounds the content of tabs. The mini panel can
-similarly be customized. Have a look at the following classes in the CDS css stylesheet: Note that a tab might be greyed out (disabled) when its content is
-empty. This is the case for the References tab (see Customizing
-content of tabs -> 'References tab') and the Fulltext tab (if no
-file could be found for the record).
-
- For more advanced modifications (like changing the HTML code of the
-tabs), you can modify the
-
-
diff --git a/modules/websession/doc/admin/index.html.wml b/modules/websession/doc/admin/index.html.wml
deleted file mode 100644
index f173ba370..000000000
--- a/modules/websession/doc/admin/index.html.wml
+++ /dev/null
@@ -1,29 +0,0 @@
-## $Id$
-
-## This file is part of CDS Invenio.
-## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 CERN.
-##
-## CDS Invenio is free software; you can redistribute it and/or
-## modify it under the terms of the GNU General Public License as
-## published by the Free Software Foundation; either version 2 of the
-## License, or (at your option) any later version.
-##
-## CDS Invenio is distributed in the hope that it will be useful, but
-## WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-## General Public License for more details.
-##
-## You should have received a copy of the GNU General Public License
-## along with CDS Invenio; if not, write to the Free Software Foundation, Inc.,
-## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
-
-#include "cdspage.wml" \
- title="WebSession Admin" \
- navtrail_previous_links="/admin/
- $ sessiongc -s 1d
-
-
-
diff --git a/modules/webstyle/doc/admin/Makefile.am b/modules/webstyle/doc/admin/Makefile.am
index 25e240879..ccacf1e04 100644
--- a/modules/webstyle/doc/admin/Makefile.am
+++ b/modules/webstyle/doc/admin/Makefile.am
@@ -1,36 +1,27 @@
## $Id$
## This file is part of CDS Invenio.
## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 CERN.
##
## CDS Invenio is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License as
## published by the Free Software Foundation; either version 2 of the
## License, or (at your option) any later version.
##
## CDS Invenio is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with CDS Invenio; if not, write to the Free Software Foundation, Inc.,
## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
-docdir = $(localstatedir)/www/admin/webstyle
-
-doc_DATA=index.html guide.html
-
webdoclibdir = $(libdir)/webdoc/admin
webdoclib_DATA = \
webstyle-admin.webdoc \
webstyle-admin-guide.webdoc
-FILESWML = $(wildcard $(srcdir)/*.wml)
EXTRA_DIST = $(webdoclib_DATA)
CLEANFILES = *~ *.tmp
-
-%.html: %.html.wml $(top_srcdir)/config/config.wml $(top_builddir)/config/configbis.wml $(top_srcdir)/config/cdsnavbar.wml
- $(WML) -o\(ALL-LANG_*\)+LANG_EN:$@ $<
- $(PYTHON) $(top_srcdir)/po/i18n_update_wml_target.py en $@
\ No newline at end of file
diff --git a/modules/webstyle/doc/admin/guide.html.wml b/modules/webstyle/doc/admin/guide.html.wml
deleted file mode 100644
index b6c64a038..000000000
--- a/modules/webstyle/doc/admin/guide.html.wml
+++ /dev/null
@@ -1,426 +0,0 @@
-## -*- mode: html; coding: utf-8; -*-
-## $Id$
-
-## This file is part of CDS Invenio.
-## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 CERN.
-##
-## CDS Invenio is free software; you can redistribute it and/or
-## modify it under the terms of the GNU General Public License as
-## published by the Free Software Foundation; either version 2 of the
-## License, or (at your option) any later version.
-##
-## CDS Invenio is distributed in the hope that it will be useful, but
-## WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-## General Public License for more details.
-##
-## You should have received a copy of the GNU General Public License
-## along with CDS Invenio; if not, write to the Free Software Foundation, Inc.,
-## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
-
-#include "cdspage.wml" \
- title="WebStyle Admin Guide" \
- navtrail_previous_links="/admin/Contents
-
-
-
-
-
-
-
-
-
-
-1. Overview
-1.1 CSS Style Sheet and Images
-
-1.2 HTML Page Layout
-
-1.2.1 Layout of HTML Static Pages
-
-config.wml, you
-may alter the default page look and feel by editing page elements such
-as CDSPAGEHEADER, CDSPAGEFOOTER,
-CDSPAGEBOXLEFTTOP, CDSPAGEBOXLEFTBOTTOM,
-CDSPAGEBOXRIGHTTOP, CDSPAGEBOXRIGHTBOTTOM.1.2.2 Layout of Python Dynamic Pages
-
-config.wml, you
-may choose to use your own templates instead of the provided default
-ones by editing
-CFG_TEMPLATE_SKIN variable. Let us say you
-put ithaca there in order to use your
-own ithaca style. Now, when you start Apache, then
-instead of CDS Invenio's usual template files such
-as webbasket_templates.py the system will look for file
-named webbasket_templates_ithaca.py and will load the
-template functions from there instead, provided that they exist.
-(Otherwise it would fall back to the default ones.)ithaca style templates file?
-We do not use one of many existing templating frameworks in Python but
-a very simple programmer-friendly templating system that enables you
-to use the full power of Python to inherit from the default templates
-the output generating functions you want to reuse and to write anew
-only the functions you would like to modify.webstyle_templates_ithaca.py with the
-following content:
-
-
-
-from invenio.config import cdslang
-from invenio.webstyle_templates import Template as DefaultTemplate
-
-class Template(DefaultTemplate):
- """Ithaca style templates."""
-
- def tmpl_pagefooter(self, req=None, ln=cdslang, lastupdated=None,
- pagefooteradd=""):
- """
- Ithaca style page footer. See the default function for
- the meaning of parameters.
- """
-
- return "<hr>This site has no footer."
-
-
-
-
-
-tmpl_foo() function definition "as
- is" into the above-cited example and then you would only modify
- its HTML snippets. The important thing is to preserve the imports
- (from invenio.config import cdslang) as in the original
- webstyle_templates.py file and to preserve the
- leading whitespace Pythonic indentation.
-
(Moreover, in the future, when we shall remove the WML
- dependency, we shall provide an easy way to modify at least the
- most commonly wanted things such as page header and footer.)tmpl_foo()
- functions do not contain any business logic in them, their only
- purpose is to make the HTML presentation of data supplied to them.
- But, should you need to carry out a little data transformation,
- you can do it within the tmpl_foo() function itself,
- thanks to the full Python power.tmpl_foo() functions across all CDS Invenio
- modules in a way that will completely change the presentation of
- elements including their content, position and order on the
- screen.tmpl_foo() and tmpl_bar(), and
- you are ugrading to a new release, you may at least briefly check
- whether the function arguments are the same. A quick check of the
- body would be helpful too, in case the new release fixed some
- display-related problems in these functions.
-
-
- In order to help you in this task, we provide a tool to check
- incompatibilities between your customized templates and the default
- templates.
-
- This tool can be run before doing a 'make install',
- therefore giving you a chance to fix your templates before
- upgrading. Just run 'make check-custom-templates' to
- get the list of problems found with your templates.
-
- You can also run this tool any time after the new default
- templates have been installed, in order to ensure that
- modifications you have done to your templates are valid. To do so
- move to your CDS Invenio installation directory, and run:
- $python /opt/cds-invenio/lib/python/invenio/template.py
- --check-custom-templates
-1.3 Look of Bibliographic
-References
-
-1.4 Specific Configurations
-
-2. Detailed Record Pages
-
-
-
- +--------------Detailed record page-------------+
- | header |
- |nav. breadcrumb |
- | |
- | .--------------------------------------. |
- | .-|Info.|Ref.|Discussion.|Stats.|Fulltext|-. |
- | | '--------------------------------------' | |
- | | | |
- | | content | |
- | | | |
- | '------------------------------------------' |
- | |
- | .---------------(Mini Panel)---------------. |
- | | Mini | Mini | Mini | |
- | | File | Review | Actions | |
- | '------------------------------------------' |
- +-----------------------------------------------+
-
-
-2.1 Available tabs
-
-The following tabs are available:
-
-
-
-
-
- Name
- Description
- URL (eg. for record '10')
-
-
- Information
- Show the formatted metadata of the record
-
-
- References
- Displays the references (bibliography) of the record
-
-
- Discussion
- Displays the users' comments and reviews
-
-
-
- Usage Statistics
- Statistics data and graph about file downloads/views
- Fulltext
- Link(s) to fulltext file(s)
-
-
-
-2.2 Showing/Hiding tabs
-
-
-
-
-CFG_WEBCOMMENT_ALLOW_COMMENTS and
- CFG_WEBCOMMENT_ALLOW_REVIEWS variable in your config file).2.3 Customizing content of tabs
-
-
-
-tmpl_detailed_record_metadata(..) in websearch_templates.py.
- By default tmpl_detailed_record_metadata simply returns the result
- of the formatting of the metadata by BibFormat using the "HD" output
- format. It can therefore be collection-specific.tmpl_detailed_record_references(..) in websearch_templates.py.
- By default tmpl_detailed_record_metadata simply returns the result
- of the formatting of the metadata by BibFormat using the "HDREF"
- output format. If the result returned by BibFormat is empty, the tab
- is disabled (visible, but not clickable). It can therefore be
- collection-specific.tmpl_get_comments(..) in webcomment_templates.py. Other
- functions in this file are also involved in the display.tmpl_detailed_record_statistics(..) in websearch_templates.py.
- If the returned content is empty, then the tabs will be disabled
- (visible, but cannot be clicked).tmpl_filelist(..)
- in websubmit_templates.py.
-
-
-
-tmpl_mini_review(..) inside webcomment_templates.pyHDACT. It can therefore be collection-specific.2.4 Customizing look of tabs
-
-
-
-
-tabsmini-paneldetailedtop-left, top-right, bottom-left, bottom-rightcommentHB, detailedRecordActions, star, miniReviewdetailed_record_container(..) and
-detailed_record_mini_panel(..) functions inside your
-webstyle_templates.py file.
-