| /trunk/README r19 | /trunk/README r21 | ||
| 1 | ============================================================== | 1 | ============================================================== |
|---|---|---|---|
| 2 | Croquant - set of MoinMoin plugin for integration with Crunchy | 2 | Croquant - set of MoinMoin plugin for integration with Crunchy |
| 3 | ============================================================== | 3 | ============================================================== |
| 4 | 4 | ||
| 5 | Croquant aim to write easily Crunchy python tutorials using the MoinMoin python | 5 | Croquant aim to write easily Crunchy python tutorials using the MoinMoin python |
| 6 | engine. | 6 | engine. |
| 7 | 7 | ||
| 8 | Installation | 8 | Installation |
| 9 | ============ | 9 | ============ |
| 10 | 10 | ||
| 11 | Just copy all files from to | 11 | Just copy all files from to |
| 12 | parser/ YOUR_WIKI/data/plugin/parser/ | 12 | parser/ YOUR_WIKI/data/plugin/parser/ |
| 13 | macro/ YOUR_WIKI/data/plugin/macro/ | 13 | macro/ YOUR_WIKI/data/plugin/macro/ |
| 14 | style/crunchy YOUR_WIKI/htdocs/crunchy/ | 14 | style/crunchy YOUR_WIKI/htdocs/crunchy/ |
| 15 | style/crunchy.py YOUR_WIKI/data/plugin/theme/ | 15 | style/crunchy.py YOUR_WIKI/data/plugin/theme/ |
| 16 | 16 | ||
| 17 | You can also use the setup.sh: | 17 | You can also use the setup.sh: |
| 18 | $ ./setup.sh YOUR_WIKI | 18 | $ ./setup.sh YOUR_WIKI |
| 19 | 19 | ||
| 20 | With parsers and macros, a crunchy theme is installed. If you want to use it | 20 | With parsers and macros, a crunchy theme is installed. If you want to use it |
| 21 | as default, a configuration file is provided in style/wikiconfig.py. | 21 | as default, a configuration file is provided in style/wikiconfig.py. |
| 22 | If you use MoinMoin 1.7.0 Desktop Edition, you can copy this file in | 22 | If you use MoinMoin 1.7.0 Desktop Edition, you can copy this file in |
| 23 | moin-1.7.0/wikiconfig_local.py | 23 | moin-1.7.0/wikiconfig_local.py |
| 24 | You can also use the configuration file style/wikiconfig_python.py to make the | 24 | You can also use the configuration file style/wikiconfig_python.py to make the |
| 25 | theme behave like the one of wiki.python.org. | 25 | theme behave like the one of wiki.python.org. |
| 26 | 26 | ||
| 27 | Usage | 27 | Usage |
| 28 | ====== | 28 | ====== |
| 29 | 29 | ||
| 30 | You can insert a interpreter in your page by: | 30 | You can insert a interpreter in your page by: |
| 31 | {{{#!crunchy interpreter | 31 | {{{#!crunchy interpreter |
| 32 | message = "Hello world" | 32 | message = "Hello world" |
| 33 | print message | 33 | print message |
| 34 | }}} | 34 | }}} |
| 35 | After "{{{#!cruncy", you can set the same VLAM markup than in Crunchy regular | 35 | After "{{{#!cruncy", you can set the same VLAM markup than in Crunchy regular |
| 36 | HTML pages. | 36 | HTML pages. |
| 37 | 37 | ||
| 38 | Some macros are available: | 38 | Some macros are available: |
| 39 | <<ExternalLink(url, name)>> to open a link without Crunchy. | 39 | <<ExternalLink(url, name)>> to open a link without Crunchy. |
| 40 | <<LoadLocal>> to add a browser to load a local tutorial | 40 | <<LoadLocal>> to add a browser to load a local tutorial |
| 41 | <<LoadRemote([url]) to add a field to load a remote tutorial | 41 | <<LoadRemote([url]) to add a field to load a remote tutorial |
| 42 | 42 | ||
| 43 | For more informations about VLAM, see the Crunchy documentation. | 43 | For more informations about VLAM, see the Crunchy documentation. |
| 44 | Addition to the wiki syntax added by croquant are described here: | 44 | Addition to the wiki syntax added by croquant are described in the file |
| 45 | <http://code.google.com/p/crunchy/wiki/WikiSyntax> | 45 | doc/syntax.rst |
| 46 | 46 | ||
| 47 | File name confusions | 47 | File name confusions |
| 48 | ==================== | 48 | ==================== |
| 49 | 49 | ||
| 50 | Please note there is many files named "crunchy.py". They are not the same file | 50 | Please note there is many files named "crunchy.py". They are not the same file |
| 51 | at all! If you plan to setup a wiki using Croquant, you must be careful about | 51 | at all! If you plan to setup a wiki using Croquant, you must be careful about |
| 52 | the role of each: | 52 | the role of each: |
| 53 | * parser/crunchy.py is the paser used when you write a block of python code | 53 | * parser/crunchy.py is the paser used when you write a block of python code |
| 54 | with VLAM instructions for Crunchy, inside a MoinMoin page. | 54 | with VLAM instructions for Crunchy, inside a MoinMoin page. |
| 55 | * style/crunchy.py is a part of the crunchy theme for MoinMoin | 55 | * style/crunchy.py is a part of the crunchy theme for MoinMoin |
| 56 | There is also a file named crunchy.py in the crunchy application, which is | 56 | There is also a file named crunchy.py in the crunchy application, which is |
| 57 | used to start crunchy. | 57 | used to start crunchy. |
| 58 | 58 | ||
| 59 | See also | 59 | See also |
| 60 | ======== | 60 | ======== |
| 61 | * Python: <http://python.org/> | 61 | * Python: <http://python.org/> |
| 62 | * Crunchy: <http://code.google.com/p/crunchy/> | 62 | * Crunchy: <http://code.google.com/p/crunchy/> |
| 63 | * MoinMoin: <http://moinmo.in/> | 63 | * MoinMoin: <http://moinmo.in/> |
| 64 | * Croquant: <http://code.google.com/p/croquant/> | 64 | * Croquant: <http://code.google.com/p/croquant/> |
| 65 | 65 | ||
| 66 | Copyright | 66 | Copyright |
| 67 | ========= | 67 | ========= |
| 68 | 68 | ||
| 69 | Copyright (c) 2008 Florian Birée <florian.biree@gmail.com> | 69 | Copyright (c) 2008 Florian Birée <florian.biree@gmail.com> |
| 70 | 70 | ||
| 71 | All rights reserved, see LICENSE for details. | 71 | All rights reserved, see LICENSE for details. |
| 72 | 72 | ||
| 73 | This program is free software; you can redistribute it and/or modify | 73 | This program is free software; you can redistribute it and/or modify |
| 74 | it under the terms of the GNU General Public License as published by | 74 | it under the terms of the GNU General Public License as published by |
| 75 | the Free Software Foundation; either version 2 of the License, or | 75 | the Free Software Foundation; either version 2 of the License, or |
| 76 | (at your option) any later version. | 76 | (at your option) any later version. |
| 77 | 77 | ||
| 78 | This program is distributed in the hope that it will be useful, | 78 | This program is distributed in the hope that it will be useful, |
| 79 | but WITHOUT ANY WARRANTY; without even the implied warranty of | 79 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 80 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 80 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 81 | GNU General Public License for more details. | 81 | GNU General Public License for more details. |
| 82 | 82 | ||
| 83 | You should have received a copy of the GNU General Public License | 83 | You should have received a copy of the GNU General Public License |
| 84 | along with this program; if not, write to the Free Software | 84 | along with this program; if not, write to the Free Software |
| 85 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | 85 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
