| /trunk/README r22 | /trunk/README r25 | ||
| 1 | ================================================================ | 1 | ================================================================ |
|---|---|---|---|
| 2 | Croquant - set of MoinMoin plugins for integration with Crunchy | 2 | Croquant - set of MoinMoin plugins for integration with Crunchy |
| 3 | ================================================================ | 3 | ================================================================ |
| 4 | 4 | ||
| 5 | Croquant aims to facilitate writing Crunchy python tutorials using the | 5 | Croquant aims to facilitate writing Crunchy python tutorials using the |
| 6 | MoinMoin wiki server. It has been tested with the desktop | 6 | MoinMoin wiki server. It has been tested with the desktop |
| 7 | edition of MoinMoin 1.7.0. | 7 | edition of MoinMoin 1.7.0. |
| 8 | 8 | ||
| 9 | Installation | 9 | Installation |
| 10 | ============ | 10 | ============ |
| 11 | 11 | ||
| 12 | The tedious way to install Croquant is simply to copy all files | 12 | The tedious way to install Croquant is simply to copy all files |
| 13 | 13 | ||
| 14 | from to | 14 | from to |
| 15 | ----------------------------------------- | 15 | ----------------------------------------- |
| 16 | parser/ YOUR_WIKI/data/plugin/parser/ | 16 | parser/ YOUR_WIKI/data/plugin/parser/ |
| 17 | macro/ YOUR_WIKI/data/plugin/macro/ | 17 | macro/ YOUR_WIKI/data/plugin/macro/ |
| 18 | style/crunchy YOUR_WIKI/htdocs/crunchy/ | 18 | theme/crunchy YOUR_WIKI/htdocs/crunchy/ |
| 19 | style/crunchy.py YOUR_WIKI/data/plugin/theme/ | 19 | theme/crunchy.py YOUR_WIKI/data/plugin/theme/ |
| 20 | 20 | ||
| 21 | You can also do the same automatically using install.py as follows: | 21 | You can also do the same automatically using install.py as follows: |
| 22 | $ python install.py YOUR_WIKI | 22 | $ python install.py YOUR_WIKI |
| 23 | 23 | ||
| 24 | where YOUR_WIKI could be something like full/path/moin-1.7.0/wiki/ | 24 | where YOUR_WIKI could be something like full/path/moin-1.7.0/wiki/ |
| 25 | 25 | ||
| 26 | With parsers and macros, a Crunchy theme is installed. If you want to use it | 26 | With parsers and macros, a Crunchy theme is installed. If you want to use it |
| 27 | as the default, a configuration file is provided in style/wikiconfig.py. | 27 | as the default, a configuration file is provided in style/wikiconfig.py. |
| 28 | If you use MoinMoin 1.7.0 Desktop Edition, you can copy this file in | 28 | If you use MoinMoin 1.7.0 Desktop Edition, you can copy this file in |
| 29 | moin-1.7.0/wikiconfig_local.py | 29 | moin-1.7.0/wikiconfig_local.py |
| 30 | 30 | ||
| 31 | You can also use the configuration file style/wikiconfig_python.py to make the | 31 | You can also use the configuration file style/wikiconfig_python.py to make the |
| 32 | theme behave similarly to the one of wiki.python.org by copying it to | 32 | theme behave similarly to the one of wiki.python.org by copying it to |
| 33 | moin-1.7.0/wikiconfig_local.py | 33 | moin-1.7.0/wikiconfig_local.py |
| 34 | 34 | ||
| 35 | 35 | ||
| 36 | File name confusions | 36 | File name confusions |
| 37 | ==================== | 37 | ==================== |
| 38 | 38 | ||
| 39 | Please note there are a few files named "crunchy.py". They are not the same file | 39 | Please note there are a few files named "crunchy.py". They are not the same file |
| 40 | at all! If you plan to setup a wiki using Croquant, you must be careful about | 40 | at all! If you plan to setup a wiki using Croquant, you must be careful about |
| 41 | the role of each: | 41 | the role of each: |
| 42 | 42 | ||
| 43 | * parser/crunchy.py is the parser used when you write a block of python code | 43 | * parser/crunchy.py is the parser used when you write a block of python code |
| 44 | with VLAM instructions for Crunchy, inside a MoinMoin page. | 44 | with VLAM instructions for Crunchy, inside a MoinMoin page. |
| 45 | * style/crunchy.py is a part of the crunchy theme for MoinMoin | 45 | * style/crunchy.py is a part of the crunchy theme for MoinMoin |
| 46 | 46 | ||
| 47 | There is also a file named crunchy.py in the Crunchy application, which is | 47 | There is also a file named crunchy.py in the Crunchy application, which is |
| 48 | used to start Crunchy itself. | 48 | used to start Crunchy itself. |
| 49 | 49 | ||
| 50 | See also | 50 | See also |
| 51 | ======== | 51 | ======== |
| 52 | * Python: <http://python.org/> | 52 | * Python: <http://python.org/> |
| 53 | * Crunchy: <http://code.google.com/p/crunchy/> | 53 | * Crunchy: <http://code.google.com/p/crunchy/> |
| 54 | * MoinMoin: <http://moinmo.in/> | 54 | * MoinMoin: <http://moinmo.in/> |
| 55 | * Croquant: <http://code.google.com/p/croquant/> | 55 | * Croquant: <http://code.google.com/p/croquant/> |
| 56 | 56 | ||
| 57 | Copyright | 57 | Copyright |
| 58 | ========= | 58 | ========= |
| 59 | 59 | ||
| 60 | Copyright (c) 2008 Florian Birée <florian.biree@gmail.com> | 60 | Copyright (c) 2008 Florian Birée <florian.biree@gmail.com> |
| 61 | 61 | ||
| 62 | All rights reserved, see LICENSE for details. | 62 | All rights reserved, see LICENSE for details. |
| 63 | 63 | ||
| 64 | This program is free software; you can redistribute it and/or modify | 64 | This program is free software; you can redistribute it and/or modify |
| 65 | it under the terms of the GNU General Public License as published by | 65 | it under the terms of the GNU General Public License as published by |
| 66 | the Free Software Foundation; either version 2 of the License, or | 66 | the Free Software Foundation; either version 2 of the License, or |
| 67 | (at your option) any later version. | 67 | (at your option) any later version. |
| 68 | 68 | ||
| 69 | This program is distributed in the hope that it will be useful, | 69 | This program is distributed in the hope that it will be useful, |
| 70 | but WITHOUT ANY WARRANTY; without even the implied warranty of | 70 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 71 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 71 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 72 | GNU General Public License for more details. | 72 | GNU General Public License for more details. |
| 73 | 73 | ||
| 74 | You should have received a copy of the GNU General Public License | 74 | You should have received a copy of the GNU General Public License |
| 75 | along with this program; if not, write to the Free Software | 75 | along with this program; if not, write to the Free Software |
| 76 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | 76 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
