Permalink
Browse files

Add .dist-files documentation

  • Loading branch information...
2 parents e3217ae + 51bf574 commit 76362e2153d2dfc0cf5dfb2ce65edf2e3d71859c @andreashaerter andreashaerter committed Feb 8, 2014
View
@@ -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
@@ -1,144 +0,0 @@
-
-ACHTUNG: Diese Datei stellt eine AUSZUGSWEISE Übersetzung der wichtigsten Teile
- der englischsprachigen README dar. Für den vollständigen Text bitte die
- Datei "README" in diesem Verzeichnis einsehen.
-
-
- II. Installation und Aktualisierung
-
- "vector" zu nutzen ist einfach und funktioniert wie unter
- <https://www.dokuwiki.org/template> beschrieben: Entpacken Sie das
- heruntergeladene Archiv in das "lib/tpl/"-Verzeichnis Ihrer DokuWiki. Wählen
- Sie es dann einfach im Config Manager über die "template"-Option aus.
-
- Falls Sie eine bestehende vector-Installation aktualisieren wollen, werfen
- Sie bitte einen Blick auf <https://www.dokuwiki.org/template:vector>. Dort
- sollten Sie alle benötigten Informationen finden.
-
- HINWEIS: Falls alles unformatiert angezeigt wird, ist Ihre PHP-Umgebung ggf.
- vom PHP bug Nr. 49692 betroffen (s. entsprechender Bugreport unter
- <http://bugs.php.net/bug.php?id=49692>). Sie finden evtl. Einträge
- wie "syntax error, unexpected '/' in ../../lib/tpl/vector/style.ini
- on line XX" in Ihren PHP-Logs falls dies der Fall sein sollte.
- vector bietet einen Workaround für diesen Fehler an, löschen Sie
- einfach vectors "style.ini" um das Template dazu zu bewegen,
- selbigen zu nutzen.
-
-
-
- II. Das Template anpassen
-
- Um Aktualisierungen/Updates des installierten "vector"-Templates einfach zu
- gestalten, halten Sie sich bitte an die folgenden Hinweise um das Template
- anzupassen:
-
- - Eigene Dateien in "vector/user" ablegen
- Der Ort für *alle* benutzerdefinierten, angepassten Dinge/Dateien ist
- "vector/user".
- Grund: dieses Verzeichnis wird bei Aktualisierungen nicht angerührt. Daher
- können Sie einfach alles außer "vector/user" löschen und alle neuen
- Dateien nach "vector/" kopieren um das Template zu aktualisieren, ohne
- Ihre Änderungen zu verlieren. Vergessen Sie nicht Ihren Browser-Cache
- anschließend zu leeren.
-
- - Eigenes Logo
- Falls Sie das Standard-Logo, welches in der linken oberen Ecke angezeigt
- wird, austauschen wollen, legen Sie einfach eine "logo.[png|gif|jpg]"-
- Datei im "vector/user"-Ordner an. Das Template erkennt die Datei
- automatisch und wird sie anstelle des Standard-Logos verwenden. Vergessen
- Sie nicht Ihren Browser-Cache anschließend zu leeren.
-
- - Eigenes Favicon
- Falls Sie das Standard-favicon austauschen wollen, legen Sie einfach eine
- "favicon.ico"-Datei im "vector/user"-Ordner an. Das Template erkennt die
- Datei automatisch und wird sie anstelle des Standard-Favicons verwenden.
- Vergessen Sie nicht Ihren Browser-Cache anschließend zu leeren.
- Vielleicht finden Sie das folgende Online-Werkzeug nützlich:
- <http://tools.dynamicdrive.com/favicon/>
- Hinweis: "favicon.png" ist ebenfalls möglich, wird aber nicht empfohlen
- (da es von älteren MSIE-Versionen nicht unterstützt wird).
-
- - Eigene CSS
- Um eigene CSS-Regeln anzuwenden, editieren Sie einfach
- "vector/user/screen.css" (beeinflusst das normale Erscheinungsbild)
- und/oder "vector/user/print.css" (beeinflusst das Druck-Erscheinungsbild)
- und/oder "vector/user/rtl.css" (beeinflusst "rechts-nach-links"-Sprachen
- wie Hebräisch). Diese Dateien werden automatisch eingebunden (als letzte
- für das relevante Ausgabemedium, daher können Sie auch existierende Styles
- überschreiben). Vergessen Sie nicht Ihren Browser-Cache anschließend zu
- leeren.
-
- - Eigenes JavaScript
- Um zusätzliches JavaScript zu laden, editieren Sie einfach
- "vector/user/user.js". Vergessen Sie nicht Ihren Browser-Cache
- anschließend zu leeren.
- ACHTUNG: Vergessen Sie nicht die Template-Option "vector_loaduserjs"
- (->"Datei 'vector/user/user.js' laden?") im DokuWiki Config
- Manager zu aktivieren!
-
- - Eigene CSS, sprachspezifisch
- Um eigene CSS-Regeln nur für eine bestimmte Sprache anzuwenden,
- editieren/erstellen Sie einfach "vector/lang/<ihre-sprache>/style.css".
- Diese Datei wird automatisch eingebunden, sobald DokuWiki in der Sprache
- der Wahl betrieben wird/eine Seite anzeigt (als letzte, daher können Sie
- auch existierende Styles überschreiben). Vergessen Sie nicht Ihren
- Browser-Cache anschließend zu leeren.
-
- - Eigene Tabs
- Um eigene Tabs anzuzeigen, editieren Sie einfach "vector/user/tabs.php".
- Kein Sorge: Sie finden dort einige Beispiele wie eigene Tabs definiert
- werden. Falls Sie nach dem ausprobieren der Beispiele immernoch Fragen
- haben, durchsuchen Sie am besten
- <https://www.dokuwiki.org/template:vector> und/oder das DokuWiki-Forum
- unter <https://forum.dokuwiki.org> und/oder fragen Sie die dortige
- Gemeinschaft falls Sie die Probleme beim Konfigurieren der eigenen Tabs
- nicht selbst lösen können.
- Falls "vector/user/tabs.php" nicht existiert, kopieren Sie die Datei
- einfach aus dem aktuellen Installationsarchiv.
-
- - Eigene Fußleisten-Buttons (Footer)
- Um eigene Buttons/Grafiken in der Fußleiste anzuzeigen (-> die kleinen
- 80x15 Bildchen), editieren Sie einfach "vector/user/buttons.php".
- Kein Sorge: Sie finden dort einige Beispiele wie eigene Buttons definiert
- werden. Falls Sie nach dem ausprobieren der Beispiele immernoch Fragen
- haben, durchsuchen Sie am besten
- <https://www.dokuwiki.org/template:vector> und/oder das DokuWiki-Forum
- unter <https://forum.dokuwiki.org> und/oder fragen Sie die dortige
- Gemeinschaft falls Sie die Probleme beim Konfigurieren der eigenen
- Buttons nicht selbst lösen können.
- Falls "vector/user/buttons.php" nicht existiert, kopieren Sie die Datei
- einfach aus dem aktuellen Installationsarchiv.
-
- - Eigene Boxen
- Um eigene Boxen in der linken Spalte anzuzeigen, editieren Sie einfach
- "vector/user/boxes.php". Kein Sorge: Sie finden dort einige Beispiele wie
- eigene Boxen definiert werden. Falls Sie nach dem ausprobieren der
- Beispiele immernoch Fragen haben, durchsuchen Sie am besten
- <https://www.dokuwiki.org/template:vector> und/oder das DokuWiki-Forum
- unter <https://forum.dokuwiki.org> und/oder fragen Sie die dortige
- Gemeinschaft falls Sie die Probleme beim Konfigurieren der eigenen Buttons
- nicht selbst lösen können.
- Falls "vector/user/boxes.php" nicht existiert, kopieren Sie die Datei
- einfach aus dem aktuellen Installationsarchiv.
-
- - Einbinden von Web-Analyse-Software (Piwik, Google Analytics etc.)
- Tools wie Piwik und Google Analytics benötigen normalerweise einen kleinen
- Code-Schnipsel ("tag"), welchen man auf der eigenen Website einbinden
- muss, damit alles funktionieren kann. Sofern man solche Software mit
- diesem Template einsetzen will, sollte man sich die Datei
- "vector/user/tracker.php" anschauen. Sie existiert, um die Integration
- einfacher zu gestalten und man nicht überlegen muss, wo solche Codes
- eingefügt werden müssen: dies ist der korrekte Platz dafür.
-
- - Eigenes Apple Touch Icon
- Falls Sie das Standard-Apple-Touch-Icon austauschen wollen, legen Sie
- einfach eine "apple-touch-icon.png"-Datei im "vector/user"-Ordner an.
- Das Template erkennt die Datei automatisch und wird sie anstelle des
- Standard-Icons verwenden. Falls Sie mehr Information über das Touch Icon
- benötigen finden Sie diese in der Apple Developer Datavase ("Configuring
- Web Applications" <http://j.mp/sx3NMT>).
-
-
-[...Ende der AUSZUGSWEISEN Übersetzung der englischsprachigen README. Für den
-vollständigen Text bitte die Datei "README" in diesem Verzeichnis einsehen.]
-
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.