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