1 2 I. About 3 4 "prsnl10" is a minimalist template for DokuWiki. It is designed to use 5 DokuWiki as CMS for portfolio websites and other "non-wiki" purposes. The 6 name means "personal template 2010" because it was created the personal 7 website of Andreas Haerter [1] in 2010. 8 9 Website: <https://www.dokuwiki.org/template:prsnl10> 10 Maintainer: ARSAVA <https://dev.arsava.com/> 11 Contact: See "IV. Support" and "V. Contact". 12 13 [1] <https://andreashaerter.com/> 14 15 16 17 II. Installation and update 18 19 The installation works as described [1] on DokuWiki.org. Extract the 20 downloaded archive into your DokuWiki's "lib/tpl/" folder. Then select the 21 template in the Config Manager by adjusting the template option. 22 23 See the prsnl10 template website for update instructions [2]. 24 25 [1] <https://www.dokuwiki.org/template> 26 [2] <https://www.dokuwiki.org/template:prsnl10#update> 27 28 29 30 III. Customizing the template 31 32 In order to make updates of your installed "prsnl10" template easy, follow 33 these hints for customizing the template: 34 35 - Place your files in "prsnl10/user" 36 The place to store *all* user-defined, custom stuff is the "prsnl10/user" 37 directory because your files will not be touched or overwritten on 38 template updates! So you normally can copy all new files into "prsnl10/" 39 to update the template without loosing your changes. 40 Note: There are example files helping you modifying the template. 41 The are delivered with the ".dist" extensions. Just remove the 42 ".dist" extension to use them. 43 44 - Own logo 45 If you want to replace the default logo showed in the upper left, simply 46 create a "logo.[png|gif|jpg]" in "monobook/user". The template recognizes 47 the file automatically and will use it instead of the default text. 48 Note: Do not forget to empty your browser's cache if you cannot see any 49 effect. 50 Hint: If you want to use a text-based logo, you might find the font 51 files [1] for "Droid Sans" out of Google's Webfont Directory [2] 52 useful. 53 54 - Own favicon 55 If you want to replace the default favicon, simply create a "favicon.ico" 56 in "prsnl10/user". The template recognizes the file automatically and 57 will use it instead of the default one. You might find the online FavIcon 58 Generator [3] useful. 59 Note: "favicon.png" is also possible but not recommended (because it is 60 not supported by older MSIE versions). 61 62 - Own CSS 63 To apply additional CSS rules, create a 64 - "prsnl10/user/screen.css" file to influence the normal layout. You 65 can rename the "screen.css.dist" to "screen.css" as starting point. 66 - "prsnl10/user/print.css" file to influence the print layout. You 67 can rename the "print.css.dist" to "print.css" as starting point. 68 - "prsnl10/user/rtl.css" file to influences "right-to-left" languages 69 like Hebrew. You can rename the "rtl.css.dist" to "rtl.css" as 70 starting point. 71 The file(s) will be included automatically (as the last ones for the 72 relevant media, therefore you are able to overrule existing styles). 73 Note: Do not forget to empty your browser's cache if you cannot see any 74 effect. 75 76 - Own JavaScript 77 To load additional JavaScript, create a "prsnl10/user/user.js" file. You 78 can rename the "user.js.dist" to "user.js" as starting point (it contains 79 some examples and useful comments how to define your own JavaScript). 80 ATTENTION: You have to activate the template option "prsnl10_loaduserjs" 81 (->"Load 'prsnl10/user/user.js'?") in the DokuWiki Config 82 Manager! 83 84 - Web analytics software (Piwik, Google Analytics etc.) 85 Tools like Piwik and Google Analytics normally provide a small code 86 snippet ("tag") which you have to include at your website to make 87 everything work. If you want to use such software with this template, 88 create a "prsnl10/user/tracker.php.dist". You don't have to deliberate 89 where you have to copy and paste the code, simply do it there. You can 90 rename the "tracker.php.dist" to "tracker.php" as a good starting point 91 (it contains some examples and useful comments how to define your own 92 boxes). 93 94 - Own Apple Touch Icon 95 If you want to replace the default Apple Touch Icon, simply create a 96 "apple-touch-icon.png" in "prsnl10/user". The template recognizes the file 97 automatically and will use it instead of the default one. Have a look at 98 Apple's developer database (cf. "Configuring Web Applications" [4]) if you 99 need more information. 100 101 [1] <http://www.google.com/webfonts/family?family=Droid+Sans> 102 [2] <http://j.mp/inYDGL> 103 [3] <http://tools.dynamicdrive.com/favicon/> 104 [4] <http://j.mp/sx3NMT> 105 106 107 108 IV. Support 109 110 If you need help, check the FAQ [1] and try to find useful information by 111 using the DokuWiki Search page [2]. If you found nothing helpful, ask your 112 question at the DokuWiki forum [3] (preferred) or IRC channel [4]. 113 114 [1] <https://www.dokuwiki.org/template:prsnl10#faq> 115 [2] <http://search.dokuwiki.org/> 116 [3] <https://forum.dokuwiki.org/> 117 [4] <https://www.dokuwiki.org/irc> 118 119 120 121 V. Contact 122 123 If you think you have found a bug or have a useful idea (a.k.a. "feature 124 request"), create an issue [1] on GitHub (preferred), or contact us by 125 mail [2]. 126 127 Feel free to submit patches as GitHub pull requests (preferred) or by mail 128 as well. However, please try to respect the DokuWiki coding style [3] as 129 this template follows its rules. 130 131 [1] <https://github.com/arsava/dokuwiki-template-prsnl10/issues> 132 [2] ARSAVA <dokuwiki@dev.arsava.com> 133 [3] <https://www.dokuwiki.org/devel:coding_style> 134 135 136 137 VI. Other notes 138 139 If you like this free project, you might buy us a coffee [1], or get some 140 cool QR Code merchandise [2]. Thank you! :-) 141 142 Do not hesitate to contact ARSAVA [3] if you need professional DokuWiki 143 support, training or if you think we are the ones to get your project done. 144 145 [1] <https://donate.arsava.com/dokuwiki-template-prsnl10/> 146 [2] <http://goqr.me/> 147 [3] <https://dev.arsava.com/> 148 149 150 151 VII. Explanatory notes about the dirs of this template 152 153 - "prsnl10/conf" 154 Contains some configuration files (do NOT edit them!), especially 155 - default.php: default settings [1] 156 - metadata.php: configuration metadata [2] 157 158 - "prsnl10/lang" 159 Language files (subdir names = language code). You may copy the English 160 language files and translate them if your language is missing. Simply send 161 us the translated files (cf. "V. Contact") and I will include them in the 162 next release :-D. 163 164 - "prsnl10/css" 165 All Cascading Style Sheets (CSS). See my tutorial [3] for more information 166 about how the CSS is handled. 167 168 - "prsnl10/images" 169 Images files. 170 171 - "prsnl10/js" 172 JavaScript files. 173 174 - "prsnl10/user" 175 Place for userdefined stuff. E.g. if you want use an own logo, simply copy 176 a logo.[png|gif|jpg] in here. See "III. Customizing the template" for 177 details. 178 179 [1] <https://www.dokuwiki.org/devel:configuration#default_settings> 180 [2] <https://www.dokuwiki.org/devel:configuration#configuration_metadata> 181 [3] <http://j.mp/eq8zSo> 182 183 184 185 VIII. Creation transcript 186 187 Some developers may find this interesting. Additionally, I am very oblivious 188 :-P. 189 190 In principle, I followed my own tutorial [1]. There was just no "starter" 191 template [2] when "prsnl10" was created. Therefore, after ~1 year, I 192 switched the CSS base from DokuWiki's default template to the starter 193 template, but the markup of "main.php" is still based on the default 194 template's "main.php". 195 196 [1] <http://j.mp/eq8zSo> 197 [2] <https://www.dokuwiki.org/template:starter> 198 199
