projects
/
koha.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
updated release notes for 3.14.0 beta
[koha.git]
/
koha-tmpl
/
templates.readme
diff --git
a/koha-tmpl/templates.readme
b/koha-tmpl/templates.readme
index
f771c1c
..
2a48ed5
100644
(file)
--- a/
koha-tmpl/templates.readme
+++ b/
koha-tmpl/templates.readme
@@
-1,10
+1,10
@@
-This is a README
-
file for all interested in the templating system used
+This is a README
file for all interested in the templating system used
by Koha. It contains guidelines ans descriptions, please feel free to
make comments and contributions to this file.
1. Introduction
by Koha. It contains guidelines ans descriptions, please feel free to
make comments and contributions to this file.
1. Introduction
- The advantage of a templating
-
system is the separation of code and
+ The advantage of a templating
system is the separation of code and
design. It is much easier to read the HTML and get an imagination of
what it will look like without having it shattered by declarations and
functions. And it is also nicer being able to alter some functions
design. It is much easier to read the HTML and get an imagination of
what it will look like without having it shattered by declarations and
functions. And it is also nicer being able to alter some functions
@@
-27,7
+27,7
@@
make comments and contributions to this file.
Indeed, there is a little more to know.
Indeed, there is a little more to know.
- I recomend reading the documentation to the HTML::Template
-
module.
+ I recomend reading the documentation to the HTML::Template
module.
You can obtain it from http://www.perldoc.com/cpan/HTML/Template.html
3. How is it implemented in Koha
You can obtain it from http://www.perldoc.com/cpan/HTML/Template.html
3. How is it implemented in Koha
@@
-56,7
+56,7
@@
make comments and contributions to this file.
If you have files (either templates or files in the webspace)
which are the same for all themes or languages use the
If you have files (either templates or files in the webspace)
which are the same for all themes or languages use the
- "all"
-
directory. For example the "background.jpg" image, which
+ "all"
directory. For example the "background.jpg" image, which
is the same for all languages within a theme should go in
koha-html/(intranet|opac)-html/custommade/all/images/background.jpg).
is the same for all languages within a theme should go in
koha-html/(intranet|opac)-html/custommade/all/images/background.jpg).
@@
-65,7
+65,7
@@
make comments and contributions to this file.
Simply add an entry to the systempreferences: name=theme,
value=nameoftheme.
Simply add an entry to the systempreferences: name=theme,
value=nameoftheme.
- If you want your users be able to override your theme
-
settings enter
+ If you want your users be able to override your theme
settings enter
name=allowthemeoverride value=customtheme1,customtheme2,... (names of
themes you want to be allowed) to the preferences.
name=allowthemeoverride value=customtheme1,customtheme2,... (names of
themes you want to be allowed) to the preferences.
@@
-83,11
+83,11
@@
make comments and contributions to this file.
5.1 For the templates
5.1 For the templates
- - Use absolute paths; relative paths in
html-
tags would be relative to
+ - Use absolute paths; relative paths in
HTML
tags would be relative to
the script's position and relative paths in <TMPL_INCLUDE> would be
relative to the template.
the script's position and relative paths in <TMPL_INCLUDE> would be
relative to the template.
- - You don't have to make templates for everything in your custom
-
theme
+ - You don't have to make templates for everything in your custom
theme
or language. If you omit a template in a language, the template of
next available language is used. (Languages are tried in the order of
the user's browser settings.)
or language. If you omit a template in a language, the template of
next available language is used. (Languages are tried in the order of
the user's browser settings.)
@@
-106,7
+106,7
@@
make comments and contributions to this file.
5.2 for the scripts
5.2 for the scripts
- - Use meaningful
l
English (abbreviations) as parameter names
+ - Use meaningful English (abbreviations) as parameter names
- If you fetch a list of data, pass it completely and let the designer
decide which data to use.
- If you fetch a list of data, pass it completely and let the designer
decide which data to use.
@@
-119,6
+119,16
@@
make comments and contributions to this file.
6. Templating stuff in Koha
6. Templating stuff in Koha
+
+# FIXME
+# pathtotemplate() call has been replaced with get_template_and_user() call
+#
+# This section should be rewritten to describe the new interface.
+#
+# In the meantime, look at an example script like member.pl or search.pl
+#
+#
+
This section is to describe scripts, modules and functions within them
to handle with themes, languages and other templating stuff.
This section is to describe scripts, modules and functions within them
to handle with themes, languages and other templating stuff.
@@
-129,14
+139,14
@@
make comments and contributions to this file.
Takes a hash with the following keys:
Takes a hash with the following keys:
- -template: the name of the template
-
file (e.g. 'mytemplate.tmpl')
+ -template: the name of the template
file (e.g. 'mytemplate.tmpl')
-type: 'opac', 'intranet', 'none' or something you specify, decides
-type: 'opac', 'intranet', 'none' or something you specify, decides
- which directory to lookup
,
defaults to intranet
+ which directory to lookup
;
defaults to intranet
-'opac': /somedirs/opac-tmpl/theme/language/template.tmpl
-'opac': /somedirs/opac-tmpl/theme/language/template.tmpl
- -'int
e
ranet': /somedirs/intranet-tmpl/theme/language/template.tmpl
+ -'intranet': /somedirs/intranet-tmpl/theme/language/template.tmpl
-'none': /somedirs/theme/language/template.tmpl
-'none': /somedirs/theme/language/template.tmpl