1mmClean
2=======
3
4mmClean is clean and simple template for DokuWiki_ (standards compliant and
5simple Wiki engine written in PHP). Template has many customizable options
6including menu, keywords and description.
7
8.. _DokuWiki: http://www.dokuwiki.org
9
10.. image:: http://www.zenzire.com/site_media/apps/project/mmclean_large.png
11   :align: center
12
13Template is used on over 100 websites worldwide.
14
15mmClean has the following features
16
17  - Menu and Sidebar Menu - customizable menu, that is displayed on every page
18  - Keywords - user defined meta tag for every generated page
19  - Description - user defined meta tag for every generated page
20
21
22Selected Users:
23=============================
24
25  - http://www.demod.org
26  - http://www.Happy-Electronics.eu
27  - http://summit.fas.harvard.edu/~meade
28  - http://pi.lastr.us/
29  - http://www.cs.famaf.unc.edu.ar/~francolq/
30
31
32Installation
33=============================
34
35  1. Download the mmClean template zip-file
36  #. Unpack it into *<dokuwiki>/lib/tpl/* directory
37  #. Change template parameter to mmclean in *<dokuwiki>/conf/local.php* file
38
39    ::
40
41      $conf['template'] = 'mmclean';
42
43
44Configuration
45=============================
46Configuration parameters are located in *<dokuwiki>/lib/tpl/mmclean/conf.php*
47PHP file.
48
49============== ================================================================
50Parameter      Description
51============== ================================================================
52keywords       Keywords META tag. This tag is inserted to every rendered page.
53               Keywords are used by search engine to improve the quality of
54               search results.
55description    Description META tag. This tag is inserted on every rendered page
56footer         Text that is inserted in the footer
57menu2Permanent menu2 is permanent (it is taken from main directory)
58wikiBar        Display Wikibar (Recent Changes, Old Version, Login)
59searchForm     Display Search Form
60============== ================================================================
61
62
63File structure
64=============================
65
66  ::
67
68    + pages
69    |-- menu1.txt      [1]
70    |-- start.txt
71    |-+ projects
72      |-- menu1.txt    [1]
73      |-- menu2.txt    [2]
74      |-- mmclean
75
76
77menu1.txt
78------------------------------
79menu1.txt file is displayed on every generated web page and it contains main menu
80content.
81
82  ::
83
84    * [[/|Blog]]
85    * [[photography|Photography]]
86    * [[projects|Software]]
87    * [[articles|Design]]
88
89
90menu2.txt
91------------------------------
92menu2.txt file is displayed on every generated web page and it constains sidebar menu content.
93
94  ::
95
96    * __DokuWiki__
97    * [[:sofwtare/mmClean|mmClean]]
98
99    * __Web Development__
100    * [[:design/modelarstwo|Modelartstwo]]
101
102
103Download
104=======================================
105
106mmClean releases are available for download from
107http://github.com/zenzire/mmclean/downloads
108
109
110Source Code
111=======================================
112
113Source code is available on http://github.com/zenzire/mmclean/
114
115
116Changelog
117================================
118
119Version 2.2 (2010-May-29)
120  - Added hilighting the active page (Daniel Schmidt)
121
122Version 2.1 (2007-Oct-31)
123  - Added User Profile to Bottom Bar
124
125Version 2.0 (2007-Jan-16)
126  - Updated media manager to DokuWiki 2006-11-06
127  - Added support for DokuWiki rewrite option (0, 1 and 2)
128  - Added new configuration options (menu2Permanent, wikiBar and searchForm)
129
130Version 1.4 (2006-Aug-30)
131  - Fixed problems with Edit Sidebar link
132  - Added SidebarPermanent option
133
134Version 1.3 (2006-Jun-03)
135  - Fixed problems with Table of content
136  - Added "footer" parameter in config file
137
138Version 1.2 (2006-May-17)
139  - Template valided with XHTML 1.0 Transitional
140
141Version 1.1 (2006-May-12)
142  - Removed link to Google Analytics
143
144Version 1.0 (2006-Apr-27)
145  - Initial Version
146
147
148Authors
149=======
150
151  - Marcin Mierzejewski (founder and main developer) - http://www.zenzire.com
152  - Daniel Schmidt (contributor) - http://wollmilchsau.no-ip.org/
153