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