README.md
1# Wiki Weko
2
3## Introduction
4
5Gives you a all-devices friendly 2021 MediaWiki/Wikipedia Look-and-Feel for DokuWiki
6
7* URL on dokuwiki: https://www.dokuwiki.org/template:wikiweko
8* URL on github: https://github.com/drbeco/dokuwiki-wikiweko-template
9
10## Code
11
12This is a template based on
13
14* Dokuwiki vector https://github.com/arsava/dokuwiki-template-vector
15
16## Licence
17
18* GNU Public License v2
19* See template.info.txt for main info
20* See COPYING for license info
21
22## Authors
23
24* drbeco
25* arsava
26* andreashaerter
27* klap-in
28* araname
29* splitbrain
30* hbilalshah
31
32
33## From Vector (this instructions are about to chance):
34
35
36 I. About
37
38 "vector" brings you the MediaWiki/Wikipedia 2010 look and feel for DokuWiki.
39 It is a mostly optical port of the original MediaWiki "vector" skin.
40
41 Website: <https://www.dokuwiki.org/template:vector>
42 Maintainer: ARSAVA <https://dev.arsava.com/>
43 Contact: See "IV. Support" and "V. Contact".
44
45
46
47 II. Installation and update
48
49 The installation works as described [1] on DokuWiki.org. Extract the
50 downloaded archive into your DokuWiki's "lib/tpl/" folder. Then select the
51 template in the Config Manager by adjusting the template option.
52
53 See the vector template website for update instructions [2].
54
55 [1] <https://www.dokuwiki.org/template>
56 [2] <https://www.dokuwiki.org/template:vector#update>
57
58
59
60 III. Customizing the template
61
62 In order to make updates of your installed "vector" template easy, follow
63 these hints for customizing the template:
64
65 - Place your files in "vector/user"
66 The place to store *all* user-defined, custom stuff is the "vector/user"
67 directory because your files will not be touched or overwritten on
68 template updates! So you normally can copy all new files into "vector/"
69 to update the template without loosing your changes.
70 Note: There are example files helping you modifying the template.
71 The are delivered with the ".dist" extensions. Just remove the
72 ".dist" extension to use them.
73
74 - Own logo
75 If you want to replace the default logo showed in the upper left, simply
76 create a "logo.[png|gif|jpg]" in "vector/user". The template recognizes
77 the file automatically and will use it instead of the default logo.
78 Note: Do not forget to empty your browser's cache if you cannot see any
79 effect.
80
81 - Own favicon
82 If you want to replace the default favicon, simply create a "favicon.ico"
83 in "vector/user". The template recognizes the file automatically and
84 will use it instead of the default one. You might find the online FavIcon
85 Generator [1] useful.
86 Note: "favicon.png" is also possible but not recommended (because it is
87 not supported by older MSIE versions).
88
89 - Own CSS
90 To apply additional CSS rules, create a
91 - "vector/user/screen.css" file to influence the normal layout. You
92 can rename the "screen.css.dist" to "screen.css" as starting point.
93 - "vector/user/print.css" file to influence the print layout. You
94 can rename the "print.css.dist" to "print.css" as starting point.
95 - "vector/user/rtl.css" file to influences "right-to-left" languages
96 like Hebrew. You can rename the "rtl.css.dist" to "rtl.css" as
97 starting point.
98 The file(s) will be included automatically (as the last ones for the
99 relevant media, therefore you are able to overrule existing styles).
100 Note: Do not forget to empty your browser's cache if you cannot see any
101 effect.
102
103 - Own JavaScript
104 To load additional JavaScript, create a "vector/user/user.js" file. You
105 can rename the "user.js.dist" to "user.js" as starting point (it contains
106 some examples and useful comments how to define your own JavaScript).
107 ATTENTION: You have to activate the template option "vector_loaduserjs"
108 (->"Load 'vector/user/user.js'?") in the DokuWiki Config
109 Manager!
110
111 - Own CSS, language specific
112 To apply additional CSS rules only for a specific language, edit/create
113 "vector/lang/<your-language>/style.css". This file will be included
114 automatically if DokuWiki runs/shows a page in the language of choice (as
115 the last one, therefore you are able to overrule existing styles).
116 Note: Do not forget to empty your browser's cache if you cannot see any
117 effect.
118
119 - Own tabs
120 To apply own tabs, create a "vector/user/tabs.php" file. You can rename
121 the "tabs.php.dist" to "tabs.php" as a good starting point (it contains
122 some examples and useful comments how to define your own tabs). If you
123 still have questions after playing with the examples, see "IV. Support"
124 on how to get help.
125
126 - Own footer buttons
127 To apply own buttons/graphics in the footer (-> these small 80x15 pics),
128 create a "vector/user/buttons.php" file. You can rename the
129 "buttons.php.dist" to "buttons.php" as a good starting point (it contains
130 some examples and useful comments how to define your own buttons). If you
131 still have questions after playing with the examples, see "IV. Support"
132 on how to get help.
133
134 - Own boxes
135 To apply own boxes in the left column/sidebar, create a
136 "vector/user/boxes.php" file. You can rename the "boxes.php.dist" to
137 "boxes.php" as a good starting point (it contains some examples and useful
138 comments how to define your own boxes). If you still have questions after
139 playing with the examples, see "IV. Support" on how to get help.
140
141 - Web analytics software (Piwik, Google Analytics etc.)
142 Tools like Piwik and Google Analytics normally provide a small code
143 snippet ("tag") which you have to include at your website to make
144 everything work. If you want to use such software with this template,
145 create a "vector/user/tracker.php.dist". You don't have to deliberate
146 where you have to copy and paste the code, simply do it there. You can
147 rename the "tracker.php.dist" to "tracker.php" as a good starting point
148 (it contains some examples and useful comments how to define your own
149 boxes).
150
151 - Own Apple Touch Icon
152 If you want to replace the default Apple Touch Icon, simply create a
153 "apple-touch-icon.png" in "vector/user". The template recognizes the file
154 automatically and will use it instead of the default one. Have a look at
155 Apple's developer database (cf. "Configuring Web Applications" [2]) if you
156 need more information.
157
158 [1] <http://tools.dynamicdrive.com/favicon/>
159 [2] <http://j.mp/sx3NMT>
160
161
162
163 IV. Support
164
165 If you need help, check the FAQ [1] and try to find useful information by
166 using the DokuWiki Search page [2]. If you found nothing helpful, ask your
167 question at the DokuWiki forum [3] (preferred) or IRC channel [4].
168
169 [1] <https://www.dokuwiki.org/template:vector#faq>
170 [2] <http://search.dokuwiki.org/>
171 [3] <https://forum.dokuwiki.org/>
172 [4] <https://www.dokuwiki.org/irc>
173
174
175
176 V. Contact
177
178 If you think you have found a bug or have a useful idea (a.k.a. "feature
179 request"), create an issue [1] on GitHub (preferred), or contact us by
180 mail [2].
181
182 Feel free to submit patches as GitHub pull requests (preferred) or by mail
183 as well. However, please try to respect the DokuWiki coding style [3] as
184 this template follows its rules.
185
186 [1] <https://github.com/arsava/dokuwiki-template-vector/issues>
187 [2] ARSAVA <dokuwiki@dev.arsava.com>
188 [3] <https://www.dokuwiki.org/devel:coding_style>
189
190
191
192 VI. Other notes
193
194 If you like this free project, you might buy us a coffee [1], or get some
195 cool QR Code merchandise [2]. Thank you! :-)
196
197 Do not hesitate to contact ARSAVA [3] if you need professional DokuWiki
198 support, training or if you think we are the ones to get your project done.
199
200 [1] <https://donate.arsava.com/dokuwiki-template-vector/>
201 [2] <http://goqr.me/>
202 [3] <https://dev.arsava.com/>
203
204
205
206 VII. Explanatory notes about the dirs of this template
207
208 - "vector/conf"
209 Contains some configuration files (do NOT edit them!), especially
210 - default.php: default settings [1]
211 - metadata.php: configuration metadata [2]
212
213 - "vector/lang"
214 Language files (subdir names = language code). You may copy the English
215 language files and translate them if your language is missing. Simply send
216 us the translated files (cf. "V. Contact") and I will include them in the
217 next release :-D.
218
219 - "vector/static"
220 Static files (images, CSS, JavaScript). The interesting stuff is located
221 in subdirs (as described below).
222 - "3rd"
223 Static files originally taken from a third party like MediaWiki or
224 DokuWiki. The subdir "dokuwiki" contains files originally taken from the
225 DokuWiki "default" or "starter" template. The subdir "vector" contains
226 files taken from the MediaWiki "vector" skin.
227 - "css"
228 All non-3rd-party Cascading Style Sheets (CSS). See my tutorial [3] for
229 more information about how the CSS is handled.
230 - "img"
231 All non-3rd-party images files.
232 - "js"
233 All non-3rd-party JavaScript files.
234
235 - "vector/user"
236 Place for userdefined stuff. E.g. if you want use an own logo, simply copy
237 a logo.[png|gif|jpg] in here. See "III. Customizing the template" for
238 details.
239
240 [1] <https://www.dokuwiki.org/devel:configuration#default_settings>
241 [2] <https://www.dokuwiki.org/devel:configuration#configuration_metadata>
242 [3] <http://j.mp/eq8zSo>
243
244
245
246 VIII. Creation transcript
247
248 Some developers may find this interesting. Additionally, I am very oblivious
249 :-P.
250
251 - Downloaded the nightly MediaWiki build (because only the SVN version is
252 containing the vector skin as I'm writing this) from
253 <http://toolserver.org/~vvv/mw-nightly/>.
254
255 - Installed DokuWiki (Release "2009-12-25c", "Lemming") for testing purpose.
256
257 - Copied all "monobook for DokuWiki" sources because it already fits some of
258 my needs regarding config options and non-layout features. Means: I used
259 the source of the "monobook for DokuWiki" template as base for "vector for
260 DokuWiki".
261
262 - replaced "monobook" through "vector" in:
263 - /conf/*
264 - /lang/*
265 - /detail.php
266 - /inc_cite.php
267 - /inc_detail.php
268 - /inc_mediamanager.php
269 - /main.php
270 - /mediamanager.php
271
272 - After investigation, some 3rd-party files were copied into the provided
273 places within "/vector/static/3rd".
274 - The following files were copied from the original vector skin:
275 - /skins/vector/csshover.htc
276 - /skins/vector/main-ltr.css
277 - /skins/vector/main-rtl.css
278 - /skins/vector/images/*
279 - The following files were copied from Andreas Gohr's "default" template:
280 - /default/*.css (see <http://j.mp/eq8zSo> why I did that)
281 - /default/images/closed.gif
282 - /default/images/favicon.ico
283 - /default/images/open.gif
284 - /default/images/tocdot2.gif
285 - The following files were copied from Anika Henke's's "starter" template:
286 - /starter/images/external-link.png
287 - /starter/images/unc.png
288 - /starter/images/email.png
289
290 - Edited:
291 - "/vector/static/3rd/vector/main-ltr.css"
292 "/vector/static/3rd/vector/main-rtl.css"
293 All url() rules were edited (-> replaced "url(images/" through
294 "url(static/3rd/vector/", deleted "?1" and "?2 postfixes").
295 To make this clear, a comment was added at the top of the files.
296
297 - "/vector/static/3rd/dokuwiki/design.css"
298 All url() rules were edited (-> replaced "url(images/" through
299 "url(static/3rd/dokuwiki/").
300 To make this clear, a comment was added at the top of the files.
301
302 - Visited <http://en.wikipedia.org/w/index.php?title=ASCII>, copied the
303 XHTML source and let Tidy do the dirty work to get a valid clean and
304 correctly indented base markup (after core removal, for sure). This markup
305 was then compared with the current main.php and needed changes where done.
306
307 - Created new files:
308 - "vector/static/css/print.css"
309 - "vector/static/css/rtl.css"
310 - "vector/static/css/screen.css"
311 All relevant information should be found within the inline comments.
312
313 - Worked worked worked a few days.... and done! :-P
314
315 - After ~1 year, I switched the CSS base from DokuWiki's default template
316 to <https://www.dokuwiki.org/template:starter>. See <http://j.mp/f7V4ES>
317 for more information about this. I edited some files, see
318 "vector/static/3rd/dokuwiki/00_starter-tmpl-notes.txt" for details.
319
320
