| Index: trunk/extensions/Collection/README.txt |
| — | — | @@ -1,5 +1,3 @@ |
| 2 | | -.. -*- mode: rst; coding: utf-8 -*- |
| 3 | | - |
| 4 | 2 | ==================================== |
| 5 | 3 | *Collection* Extension for MediaWiki |
| 6 | 4 | ==================================== |
| — | — | @@ -8,9 +6,10 @@ |
| 9 | 7 | ================================ |
| 10 | 8 | |
| 11 | 9 | The *Collection* extension for MediaWiki_ allows users to collect articles and |
| 12 | | -generate PDFs for article collections and single articles. |
| | 10 | +generate downloadable version in different formats (PDF, OpenDocument Text etc.) |
| | 11 | +for article collections and single articles. |
| 13 | 12 | |
| 14 | | -The extension has been developed for and tested with MediaWiki_ version 1.13 |
| | 13 | +The extension has been developed for and tested with MediaWiki_ version 1.14 |
| 15 | 14 | and later. Some features may not be avaialable with older MediaWikis or with |
| 16 | 15 | MediaWikis that don't have the `MediaWiki API`_ enabled. One example is that |
| 17 | 16 | MediaWikis < 1.13 don't have the capability to edit articles via API, thus |
| — | — | @@ -29,12 +28,12 @@ |
| 30 | 29 | ----------------------------- |
| 31 | 30 | |
| 32 | 31 | Currently Collection extension needs PHP with cURL support, |
| 33 | | -see http://de2.php.net/manual/en/book.curl.php |
| | 32 | +see http://php.net/curl |
| 34 | 33 | |
| 35 | 34 | Install and Setup a Render Server |
| 36 | 35 | --------------------------------- |
| 37 | 36 | |
| 38 | | -PDF and ZIP file generation is done by a server, which can run separately |
| | 37 | +Rendering and ZIP file generation is done by a server, which can run separately |
| 39 | 38 | from the MediaWiki installation and can be shared by different MediaWikis. |
| 40 | 39 | See the ``mw-serve`` command or the ``mwlib.cgi`` script in the mwlib_ |
| 41 | 40 | distribution. |
| — | — | @@ -75,7 +74,7 @@ |
| 76 | 75 | |
| 77 | 76 | *$wgCollectionMWServeCert (string)* |
| 78 | 77 | Filename of a SSL certificate in PEM format for the mw-serve render server. |
| 79 | | - This needs to be used for self-signed certificates, otherwise CURL will |
| | 78 | + This needs to be used for self-signed certificates, otherwise cURL will |
| 80 | 79 | throw an error. The default is null, i.e. no certificate. |
| 81 | 80 | |
| 82 | 81 | *$wgCollectionMWServeCredentials (string)* |
| — | — | @@ -178,14 +177,12 @@ |
| 179 | 178 | that each article contains the name of the license and set $wgCollectionLicenseURL |
| 180 | 179 | to an article that contains all needed licenses. |
| 181 | 180 | |
| 182 | | -* This step is needed for MediaWiki version < 1.14 (at the time of writing |
| 183 | | - version 1.14 has not been released): |
| | 181 | +* This step is only needed for MediaWiki version < 1.14: |
| | 182 | + Just before the line:: |
| 184 | 183 | |
| 185 | | - Add a portlet to the skin of your *MediaWiki* installation: Just before the line:: |
| 186 | | - |
| 187 | 184 | <div class="portlet" id="p-tb"> |
| 188 | 185 | |
| 189 | | - in the file ``skins/MonoBook.php`` or ``skins/Modern.php`` insert |
| | 186 | + in your skin file (e.g. ``skins/MonoBook.php`` or ``skins/Modern.php``) insert |
| 190 | 187 | the following code:: |
| 191 | 188 | |
| 192 | 189 | <?php |
| — | — | @@ -237,6 +234,50 @@ |
| 238 | 235 | A repository of help pages in different languages can be found on |
| 239 | 236 | `Meta-Wiki`_. |
| 240 | 237 | |
| | 238 | + The name of the help page is stored in the system message Coll-helppage and |
| | 239 | + can be adjusted by editing the wiki page [[MediaWiki:Coll-helppage]]. |
| | 240 | + |
| | 241 | +* Add a template [[Template:saved_book]] which is transcluded on top of saved |
| | 242 | + collection pages. An example for such a template can be found on the English |
| | 243 | + Wikipedia: http://en.wikipedia.org/wiki/Template:Saved_book |
| | 244 | + |
| | 245 | + The name of the template can be adjusted via the system message |
| | 246 | + Coll-savedbook_template, i.e. by editing [[MediaWiki:Coll-savedbook_template]]. |
| | 247 | + |
| | 248 | + |
| | 249 | +Customization via System Messages |
| | 250 | +================================= |
| | 251 | + |
| | 252 | +There are several system messages, which can be adjusted for a MediaWiki |
| | 253 | +installation. They can be changed by editing the wiki page |
| | 254 | +[[MediaWiki:SYSTEMMESSAGENAME]], where SYSTEMMESSAGENAME is the name of the |
| | 255 | +system message. |
| | 256 | + |
| | 257 | +* Coll-helppage: The name of the help page (see above). |
| | 258 | + The default for English language is "Help:Books", and there exist translations |
| | 259 | + for lots of different languages. |
| | 260 | + |
| | 261 | +* Coll-savedbook_template: The name of the template (w/out the Template: prefix) |
| | 262 | + included at the top of saved book pages (see above). |
| | 263 | + The default is: 'saved_book', and there exist translations for lots of |
| | 264 | + different languages. |
| | 265 | + |
| | 266 | +* Coll-book_creator_text_article: The name of a wiki page which is transcluded |
| | 267 | + on the "Start book creator" page (the page which is shown when a user clicks |
| | 268 | + on "Create a book"). |
| | 269 | + The default is: {{MediaWiki:Coll-helppage}}/Book creator text |
| | 270 | + i.e. a subpage of the configured help page named "Book creator text" |
| | 271 | + |
| | 272 | +* Coll-suggest_enabled: If set to 1, the suggestion tool is enabled. Any other |
| | 273 | + value will disable the suggestion tool. |
| | 274 | + The default is: '1', i.e. the suggestion tool is enabled. |
| | 275 | + |
| | 276 | +* Coll-order_info_article: The name of a wiki page which is included on the |
| | 277 | + Special:Book page to show order information for printed books. |
| | 278 | + The default value is: {{MediaWiki:Coll-helppage}}/PediaPress order information |
| | 279 | + i.e. a subpage of the configured help page named "PediaPress order information". |
| | 280 | + |
| | 281 | + |
| 241 | 282 | .. _mwlib: http://code.pediapress.com/wiki/wiki/mwlib |
| 242 | 283 | .. _MediaWiki: http://www.mediawiki.org/ |
| 243 | 284 | .. _`PediaPress GmbH`: http://pediapress.com/ |