README.md 4.73 KB
Newer Older
dossist's avatar
dossist committed
1 2 3
moinmoin-memodump
=================

4
A simple [MoinMoin][] theme based on [Twitter Bootstrap][].  
dossist's avatar
dossist committed
5 6
Comes with responsive navbar and sidebar.

dossist's avatar
dossist committed
7
You can create your own sidebar by creating a page called `SideBar`.
dossist's avatar
dossist committed
8 9 10

Tested with MoinMoin 1.9.7 on Python 2.7.5.

11 12
For details, please refer to [the project wiki][Wiki Home].

dossist's avatar
dossist committed
13

dossist's avatar
dossist committed
14 15
Screenshot
----------
dossist's avatar
dossist committed
16

dossist's avatar
dossist committed
17
![Main](https://github.com/dossist/moinmoin-memodump/wiki/memodump.png)
dossist's avatar
dossist committed
18

dossist's avatar
dossist committed
19 20
[More][Wiki Screenshots]

21

dossist's avatar
dossist committed
22 23 24
Install
-------

dossist's avatar
dossist committed
25
1. Get files by cloning the repository or download a zip and unpack it.  
dossist's avatar
dossist committed
26
   To clone:
dossist's avatar
dossist committed
27

dossist's avatar
dossist committed
28 29 30
    ```console
    $ git clone https://github.com/dossist/moinmoin-memodump.git
    ```
dossist's avatar
dossist committed
31

dossist's avatar
dossist committed
32 33
2. Copy `memodump.py` into plugin directory `data/plugin/theme/`.
   Location of the directory varies according to how you installed MoinMoin.
dossist's avatar
dossist committed
34

dossist's avatar
dossist committed
35 36
3. Copy directory `memodump` into static files directory `MoinMoin/web/static/htdocs/`.
   Again location of that directory will vary. It could be:
dossist's avatar
dossist committed
37 38
    * `/usr/share/moin/htdocs` if you installed MoinMoin from Ubuntu package
    * `/usr/local/lib/python2.7/dist-packages/MoinMoin/web/static/htdocs` if you installed MoinMoin from zip
dossist's avatar
dossist committed
39
    * and so on
dossist's avatar
dossist committed
40

dossist's avatar
dossist committed
41
4. Done!
dossist's avatar
dossist committed
42
   If you run MoinMoin on a server, you might have to terminate running MoinMoin processes to reflect changes.  
dossist's avatar
dossist committed
43
   e.g. on Ubuntu:
dossist's avatar
dossist committed
44

dossist's avatar
dossist committed
45 46 47
    ```console
    $ pkill moin
    ```
dossist's avatar
dossist committed
48 49 50 51 52 53 54 55 56 57


How to use
----------

There are two ways to apply the theme.

### As your personal theme, keeping default theme unchanged ###

* Log into your wiki and go to user preferences page.
dossist's avatar
dossist committed
58 59 60
  (**Settings** near the upper left corner, then **Preferences**)
* Choose **memodump** from Preferred theme dropdown box.
* Hit *save* button at the bottom of the page.
dossist's avatar
dossist committed
61 62 63

### As the default theme ###

dossist's avatar
dossist committed
64
Edit `wikiconfig.py` to change `theme_default`.
dossist's avatar
dossist committed
65

dossist's avatar
dossist committed
66 67 68
```python
    theme_default = 'memodump'
```
dossist's avatar
dossist committed
69 70 71 72 73

Please note that indentations are important in python codes, and here you must
indent the line by exactly 4 spaces.


dossist's avatar
dossist committed
74 75
Customization
-------------
76 77
For details, please refer to [the project wiki][Wiki Home].

dossist's avatar
dossist committed
78 79 80

### SideBar ###

dossist's avatar
dossist committed
81
Create a page named `SideBar` to create your own site-wide sidebar.
82
In sidebar, list items receive special menu-like styles.  
dossist's avatar
dossist committed
83 84


dossist's avatar
dossist committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
### Site logo ###

If you go with the default wikiconfig, the default logo picture will run off the navbar height.
This theme is not optimized for the default logo picture (although it won't break page design).
By disabling the logo, MoinMoin will use your site name as a text logo with a link to the FrontPage.
To do it, just comment out `logo_string` in `wikiconfig.py`:

```python
    logo_string = ...
```
↓
```python
#   logo_string = ...
```


dossist's avatar
dossist committed
101 102
### Location area ###

dossist's avatar
dossist committed
103
On top of page contents, we have an area which shows where in the wiki you are now, and when it was updated last time.  
dossist's avatar
dossist committed
104
However, showing the info on every page feels a bit redundant.
dossist's avatar
dossist committed
105 106
You can define a list of pages which comes without the info.  
Define a list `memodump_hidelocation` in `wikiconfig.py`. The list has page names as its entries.  
dossist's avatar
dossist committed
107 108 109 110
Example:

        memodump_hidelocation = [page_front_page, u'SideBar', ]

dossist's avatar
dossist committed
111
By default, `page_front_page` is the only page in the list.
dossist's avatar
dossist committed
112

113

dossist's avatar
dossist committed
114 115 116
### Menu items ###

Basic knowledge of python language is required!
dossist's avatar
dossist committed
117

dossist's avatar
dossist committed
118
By defining `memodump_menuoverride` in `wikiconfig.py`, you can override menu entries.  
dossist's avatar
dossist committed
119 120 121 122 123 124 125
Example:

        memodump_menuoverride = [
            'raw',
            'print',
        ]

126
For details, please refer to [the project wiki][Wiki EditMenu].
dossist's avatar
dossist committed
127

dossist's avatar
dossist committed
128

dossist's avatar
dossist committed
129 130 131
Limitations
-----------

132
* Some words in the theme are not translated. (Can be translated via [WikiDictionary][Wiki Translation] pages, though)
dossist's avatar
dossist committed
133
* Sidebar area is reserved even if `SideBar` page does not exist nor is accessible.
dossist's avatar
dossist committed
134 135
* editbar and actionsMenu are replaced with the theme's own menu functionality, and settings
  on the replaced will not affect the new menu.
dossist's avatar
dossist committed
136
* Original actionsMenu were listing all additional actions automatically, but the menu of this theme
dossist's avatar
dossist committed
137 138 139
  won't do so automatically.


dossist's avatar
dossist committed
140 141
License and copyrights
----------------------
dossist's avatar
dossist committed
142

dossist's avatar
dossist committed
143
Copyright 2014 dossist.  
144 145
This theme is licensed under [GNU GPL][].  
[Twitter Bootstrap][] is copyrighted by Twitter, Inc and licensed under [the MIT license][MIT].  
dossist's avatar
dossist committed
146 147
[MoinMoin][] is copyrighted by [The MoinMoin development team](https://moinmo.in/MoinCoreTeamGroup) and licensed under [GNU GPL][].  
Icons and some part of CSS were taken from the default modernized theme.  
148 149 150 151 152 153 154 155



[MoinMoin]: https://moinmo.in/
[Twitter Bootstrap]: http://getbootstrap.com/
[Wiki Home]: https://github.com/dossist/moinmoin-memodump/wiki
[Wiki EditMenu]: https://github.com/dossist/moinmoin-memodump/wiki/EditMenu
[Wiki Translation]: https://github.com/dossist/moinmoin-memodump/wiki/Translation
dossist's avatar
dossist committed
156
[Wiki Screenshots]: https://github.com/dossist/moinmoin-memodump/wiki/Screenshots
157 158
[GNU GPL]: http://www.gnu.org/licenses/gpl
[MIT]: https://github.com/twbs/bootstrap/blob/master/LICENSE