Permalink
Browse files

Add .dist-files documentation

  • Loading branch information...
andreashaerter committed Feb 8, 2014
2 parents e3217ae + 51bf574 commit 76362e2153d2dfc0cf5dfb2ce65edf2e3d71859c
View
99 README
@@ -37,38 +37,47 @@
these hints for customizing the template:
- Place your files in "vector/user"
The place for *all* userdefined, custom stuff is "vector/user".
Reason: this folder will not be touched on updates. Therefore you may
delete everything except "vector/user" and copy all new files into
"vector/" to update without loosing your changes. Do not forget to
empty your browser's cache afterwards.
The place to store *all* user-defined, custom stuff is the "vector/user"
directory because your files will not be touched or overwritten on
template updates! So you normally can copy all new files into "vector/"
to update the template without loosing your changes.
Note: There are example files helping you modifying the template.
The are delivered with the ".dist" extensions. Just remove the
".dist" extension to use them.
- Own logo
If you want to replace the default logo showed in the upper left, simply
create a "logo.[png|gif|jpg]" in "vector/user". The template recognizes
the file automatically and will use it instead of the default text. Do not
forget to empty your browser's cache afterwards.
the file automatically and will use it instead of the default logo.
Note: Do not forget to empty your browser's cache if you cannot see any
effect.
- Own favicon
If you want to replace the default favicon, simply create a "favicon.ico"
in "vector/user". The template recognizes the file automatically and
will use it instead of the default one. Do not forget to empty your
browser's cache afterwards. By the way: you might find the online
FavIcon Generator [1] useful.
will use it instead of the default one. You might find the online FavIcon
Generator [1] useful.
Note: "favicon.png" is also possible but not recommended (because it is
not supported by older MSIE versions).
- Own CSS
To apply additional CSS rules, edit "vector/user/screen.css"
(influences normal layout) and/or "vector/user/print.css" (influences
print layout) and/or "vector/user/rtl.css" (influences "right-to-left"
languages like Hebrew). These files will be included automatically (as the
last ones for the relevant media, therefore you are able to overrule
existing styles). Do not forget to empty your browser's cache afterwards.
To apply additional CSS rules, create a
- "vector/user/screen.css" file to influence the normal layout. You
can rename the "screen.css.dist" to "screen.css" as starting point.
- "vector/user/print.css" file to influence the print layout. You
can rename the "print.css.dist" to "print.css" as starting point.
- "vector/user/rtl.css" file to influences "right-to-left" languages
like Hebrew. You can rename the "rtl.css.dist" to "rtl.css" as
starting point.
The file(s) will be included automatically (as the last ones for the
relevant media, therefore you are able to overrule existing styles).
Note: Do not forget to empty your browser's cache if you cannot see any
effect.
- Own JavaScript
To load additional JavaScript, edit "vector/user/user.js". Do not
forget to empty your browser's cache afterwards.
To load additional JavaScript, create a "vector/user/user.js" file. You
can rename the "user.js.dist" to "user.js" as starting point (it contains
some examples and useful comments how to define your own JavaScript).
ATTENTION: You have to activate the template option "vector_loaduserjs"
(->"Load 'vector/user/user.js'?") in the DokuWiki Config
Manager!
@@ -77,46 +86,48 @@
To apply additional CSS rules only for a specific language, edit/create
"vector/lang/<your-language>/style.css". This file will be included
automatically if DokuWiki runs/shows a page in the language of choice (as
the last one, therefore you are able to overrule existing styles). Do
not forget to empty your browser's cache afterwards.
the last one, therefore you are able to overrule existing styles).
Note: Do not forget to empty your browser's cache if you cannot see any
effect.
- Own tabs
To apply own tabs, have a look at "vector/user/tabs.php". Don't worry:
you will find some examples how to define the tabs. If you still have
questions after playing with the examples, see "IV. Support" on how to get
help. If "vector/user/tabs.php" does not exist, simply copy it out of
the current actual installation archive.
To apply own tabs, create a "vector/user/tabs.php" file. You can rename
the "tabs.php.dist" to "tabs.php" as a good starting point (it contains
some examples and useful comments how to define your own tabs). If you
still have questions after playing with the examples, see "IV. Support"
on how to get help.
- Own footer buttons
To apply own buttons/graphics in the footer (-> these small 80x15 pics),
have a look at "vector/user/buttons.php". Don't worry: you will find
some examples how to define the buttons. If you still have questions
after playing with the examples, see "IV. Support" on how to get help.
If "vector/user/buttons.php" does not exist, simply copy it out of the
current actual installation archive.
create a "vector/user/buttons.php" file. You can rename the
"buttons.php.dist" to "buttons.php" as a good starting point (it contains
some examples and useful comments how to define your own buttons). If you
still have questions after playing with the examples, see "IV. Support"
on how to get help.
- Own boxes
To apply own boxes in the left column/sidebar, have a look at
"vector/user/boxes.php". Don't worry: you will find some examples how to
define the boxes. If you still have questions after playing with the
examples, see "IV. Support" on how to get help.
If "vector/user/boxes.php" does not exist, simply copy it out of the
current actual installation archive.
To apply own boxes in the left column/sidebar, create a
"vector/user/boxes.php" file. You can rename the "boxes.php.dist" to
"boxes.php" as a good starting point (it contains some examples and useful
comments how to define your own boxes). If you still have questions after
playing with the examples, see "IV. Support" on how to get help.
- Web analytics software (Piwik, Google Analytics etc.)
Tools like Piwik and Google Analytics normally provide a small code
snippet ("tag") which you have to include at your website to make
everything work. If you want to use such software with this template, have
a look at "vector/user/tracker.php". This file exists to make it easier
for you. You don't have to deliberate where you have to copy and paste the
code, simply do it there.
everything work. If you want to use such software with this template,
create a "vector/user/tracker.php.dist". You don't have to deliberate
where you have to copy and paste the code, simply do it there. You can
rename the "tracker.php.dist" to "tracker.php" as a good starting point
(it contains some examples and useful comments how to define your own
boxes).
- Own Apple Touch Icon
If you want to replace the default Apple Touch Icon, simply create a
"apple-touch-icon.png" in "vector/user". The template recognizes the
file automatically and will use it instead of the default one. Have a
look at Apple's developer database (cf. "Configuring Web Applications"[2])
if you need more information.
"apple-touch-icon.png" in "vector/user". The template recognizes the file
automatically and will use it instead of the default one. Have a look at
Apple's developer database (cf. "Configuring Web Applications" [2]) if you
need more information.
[1] <http://tools.dynamicdrive.com/favicon/>
[2] <http://j.mp/sx3NMT>
View
144 README-de

This file was deleted.

Oops, something went wrong.
View
@@ -95,8 +95,11 @@
} else {
$interim .= trim(file_get_contents("./static/3rd/vector/main-ltr.css"))."\n";
}
$interim .= trim(file_get_contents("./static/css/screen.css"))."\n"
.trim(file_get_contents("./user/screen.css"))."\n";
$interim .= trim(file_get_contents("./static/css/screen.css"))."\n";
if (file_exists(DOKU_TPL."user/screen.css")){
$interim .= trim(file_get_contents("./user/screen.css"))."\n";
}
//replace the placeholders with the corresponding values and send the needed CSS
echo "@media screen {\n".str_replace(//search
$placeholder_names,
@@ -107,8 +110,11 @@
//get needed file contents: print media CSS
$interim = trim(file_get_contents("./static/3rd/dokuwiki/print.css"))."\n"
.trim(file_get_contents("./static/css/print.css"))."\n"
.trim(file_get_contents("./user/print.css"))."\n";
.trim(file_get_contents("./static/css/print.css"))."\n";
if (file_exists(DOKU_TPL."user/print.css")) {
$interim .= trim(file_get_contents("./user/print.css"))."\n";
}
//replace the placeholders with the corresponding values and send the needed CSS
echo "@media print {\n".str_replace(//search
$placeholder_names,
View
@@ -243,6 +243,16 @@
}
//Languages/translations provided by Andreas Gohr's translation plugin,
//see <https://www.dokuwiki.org/plugin:translation>
if (!empty($transplugin) &&
is_object($transplugin)){
$_vector_boxes["p-lang"]["headline"] = $lang["vector_translations"];
$_vector_boxes["p-lang"]["xhtml"] = $transplugin->_showTranslations();
}
/******************************************************************************
******************************** ATTENTION *********************************
DO NOT MODIFY THIS FILE, IT WILL NOT BE PRESERVED ON UPDATES!
View
@@ -74,6 +74,15 @@
$_vector_btns["dw"]["nofollow"] = !(cleanID(getID()) === "start");
//W3C (X)HTML validator button
$_vector_btns["valid_xhtml"]["img"] = DOKU_TPL."static/img/button-xhtml.png";
$_vector_btns["valid_xhtml"]["href"] = "http://validator.w3.org/check/referer";
$_vector_btns["valid_xhtml"]["width"] = 80;
$_vector_btns["valid_xhtml"]["height"] = 15;
$_vector_btns["valid_xhtml"]["title"] = "Valid XHTML";
$_vector_btns["valid_xhtml"]["nofollow"] = true;
/******************************************************************************
******************************** ATTENTION *********************************
Oops, something went wrong.

0 comments on commit 76362e2

Please sign in to comment.