INSTALL

   1 Naiad skin for MediaWiki
   2 ========================
   3
   4 Welcome to the naiad skin, the three-column layout
   5 designed orignally for the Blender Wiki (http://wiki.blender.org).
   6
   7 Skin home page: http://wiki.blender.org/index.php/Meta:Skins/Naiad/Mediawiki
   8
   9 Copyright (c) 2011-2012 Francesco Siddi (fsiddi.com), Luca Bonavita (mindrones.com)
  10           Updated for MediaWiki 1.19 by Lockal Sash (lockal) in 2012
  11           Updated for MediaWiki 1.25 by Marcin Cieślak (saper.info) in October 2015
  12                       for the Viato GmbH, http://viato.traval/
  13
  14  * Naiad is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * Naiad is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with Naiad (COPYING file).  If not, see <http://www.gnu.org/licenses/>.
  26
  27 Installation
  28 ------------
  29
  30 To install, extract the "naiad" directory into "skins".
  31
  32 The current release requires MediaWiki 1.25 or newer.
  33
  34 Add this line to LocalSettings.php:
  35
  36    wfLoadSkin( 'naiad ');
  37
  38
  39 In order to have the table of contents of your articles
  40 presented on the right hand pane, you need to install the
  41 DeToc extension:
  42
  43    https://www.mediawiki.org/wiki/Extension:DeToc
  44
  45 and add
  46
  47    wfLoadExtension( 'DeToc' );
  48
  49
  50 Naiad will detect the availability of DeToc automatically.
  51
  52
  53 Naiad Samples
  54 -------------
  55
  56 To try out Naiad skin it is recommended to install "NaiadSamples"
  57 extension available from:
  58
  59    http://repo.or.cz/NaiadSamples
  60
  61 Add the following to your LocalSettings.php:
  62
  63    wfLoadExtension(' NaiadSamples ');
  64
  65 Naiad Samples requires also that the TreeAndMenu extension is installed:
  66
  67    http://www.mediawiki.org/wiki/Extension:TreeAndMenu
  68
  69 with
  70
  71    wfLoadExtension(' TreeAndMenu ');
  72
  73 This extension provides default values for the MediaWiki:Sidebar
  74 and other areas to show the skin features in a way similar
  75 to Blender wiki. This extension does not modify the database
  76 and will not interfere with Naiad skin customizations.
  77 It is safe to uninstall the extension at any time, even
  78 if customization is not yet complete.
  79
  80
  81 Customization
  82 =============
  83
  84 Naiad uses MediaWiki system messages (pages in the "MediaWiki"
  85 namespace) to customize content displayed on the screen.
  86
  87 Logo
  88 ----
  89
  90 Naiad will display the MediaWiki logo as defined by $wgLogo
  91 global variable. Because the default logo is too large to
  92 fit the Naiad header area, the Blender logo will be used
  93 in that case.
  94
  95 MediaWiki:Sidebar
  96 -----------------
  97
  98 Naiad uses "maintenance" and "monitoring" sidebar keys to
  99 define contents of the "wiki" menu available at the bottom
 100 of the screen.
 101
 102 "navigation" sidebar key defines links that are displayed
 103 after the user moves the mouse over the site logo.
 104
 105 An example taken from the Blender wiki (and installed
 106 with NaiadSamples extension):
 107
 108 * maintenance
 109 **http://projects.blender.org/tracker/?atid=510&group_id=163&func=brow
 110 se | Report a wiki bug
 111 **Meta:Guides/Writer_Guide|Wiki Guidelines
 112
 113 *monitoring
 114 **Special:Categories|Categories
 115 **Special:Popularpages|Popular pages
 116 **Special:Newimages|New files
 117 **Special:Newpages|New pages
 118 **recentchanges-url|recentchanges
 119
 120 *navigation
 121 **http://www.blender.org | blender.org | Don't go to blender.org websi
 122 te
 123 **http://code.blender.org | code.blender.org | Don't go to blender dev
 124 elopment blog"
 125
 126 Please refer to the https://www.mediawiki.org/wiki/Manual:Interface/Sidebar
 127 documentation for more information on creating your own sidebar.
 128 Please not that using two vertical bars (|) is the Naiad extension.
 129 The second bar will be displayed as-is when using other skins.
 130
 131 Since "navigation" is a standard item used in other skins like Vector,
 132 in case of conflict it can be renamed using MediaWiki:Naiad-sidebar-key
 133
 134
 135 MediaWiki:NavTreeTopPages
 136 -------------------------
 137
 138 This is a narrow area at the top of the left pane. The Blender wiki
 139 uses it for a drop down list of some pages.
 140
 141
 142 MediaWiki:NavTree
 143 -----------------
 144
 145 This part fills most of the left pane. The Blender wiki uses
 146 to display a usually dynamically generated list of subpages.
 147 NaiadSamples use MenuAndTree extension to reproduce that
 148 effect.
 149
 150
 151 MediaWiki:Series  MediaWiki:Languages
 152 -------------------------------------
 153
 154 Those two areas fit on the top header and may include buttons
 155 with drop-down menus. The Blender wiki uses them to
 156 allow the user to switch between documented Blender versions
 157 and to change the language version of the page, if present.
 158
 159
 160 MediaWiki:NavigationArrows
 161 --------------------------
 162
 163 Another area that can be used for a drop-down menu adjacent
 164 to Series and Languages buttons.
 165
 166
 167 MediaWiki:SearchSeries MediaWiki:SearchLanguages
 168 ------------------------------------------------
 169
 170 Those two areas displayed at the bottom bar on the screen,
 171 adjacent to the search box.
 172
 173
 174 Right hand side panel and MediaWiki:SidebarBanner
 175 -------------------------------------------------
 176
 177 Right hand side panel is used to display new message notification
 178 (if any), MediaWiki:Sitenotice, a small banner that can
 179 be optionally defined in MediaWiki:SidebarBanner
 180 as well as information generated by other extensions
 181 using the "SkinAfterContent" hook.
 182
 183 If the DeToc extension is installed, the table of contents of the
 184 current article will be displayed on the right hand side panel
 185 as well.