Metadata-Version: 1.1
Name: Wikked
Version: 0.1.0.4
Summary: A wiki engine entirely managed with text files stored in a revision control system.
Home-page: https://bitbucket.org/ludovicchabant/wikked
Author: Ludovic Chabant
Author-email: ludovic@chabant.com
License: Apache 2.0
Description: <h1>W I K K E D</h1>
        <p>Wikked is a wiki engine entirely managed with text files stored in a revision
        control system like Mercurial or Git.</p>
        <p>It's in early alpha, and will probably not work at all except on my machine. If
        you still want to try it, great! Please note that:</p>
        <ul>
        <li>On Mercurial is supported at the moment. Git support is planned.</li>
        <li>The command-line interface is temporary and incomplete.</li>
        <li>Lots of incomplete or buggy stuff. Like I said it's alpha!</li>
        <li>Please report any bug on <a href="https://github.com/ludovicchabant/Wikked">Github</a>.</li>
        </ul>
        <h2>Installation</h2>
        <p>Install Wikked the usual way:</p>
        <pre><code>pip install wikked
        </code></pre>
        <p>Or, if you're using <code>easy_install</code>:</p>
        <pre><code>easy_install wikked
        </code></pre>
        <p>You can also install it from the source, which you can find on <a href="https://bitbucket.org/ludovicchabant/wikked">BitBucket</a>
        or <a href="https://github.com/ludovicchabant/Wikked">Github</a>.</p>
        <h2>Setup</h2>
        <p>Until Wikked is feature complete with its command-line utility, there's a few
        steps needed to setup a new wiki:</p>
        <ol>
        <li>Create a new Mercurial repository: <code>hg init mywiki</code></li>
        <li>Go there: <code>cd mywiki</code></li>
        <li>Create a <code>Main Page.md</code> text file, put some text in it.</li>
        <li>Run <code>wk reset</code> to initialize the wiki.</li>
        <li>Run <code>wk runserver</code> and navigate to <code>localhost:5000</code>.</li>
        </ol>
        <p>If you're using an existing repository instead in step 1, make sure that you add
        the <code>.wiki</code> folder to your <code>.hgignore</code>, and that's where Wikked will cache some
        stuff (which you don't want committed or showing up in <code>hg status</code>).</p>
        <h2>Wiki Configuration</h2>
        <p>You can configure your wiki with a <code>.wikirc</code> file in the root of your website.</p>
        <p>Optionally, you can define a <code>.wiki/wikirc</code> file, and any settings in there will
        be merged with the <code>.wikirc</code>. The difference is that the one at the root is
        typically committed to source control, whereas the one in the <code>.wiki</code> folder
        will only be local to the current repository clone, so that makes it possible to
        have local overrides.</p>
        <p>The configuration is written in INI-style:</p>
        <pre><code>[section]
        name = value
        other = whatever
        
        [other_section]
        name = value
        </code></pre>
        <h3><code>wiki</code> Section</h3>
        <p>All the following configuration settings should be in a <code>[wiki]</code> section:</p>
        <ul>
        <li>
        <p><code>default_extension</code> (defaults to <code>md</code>): the default extension to use when
          creating new pages.</p>
        </li>
        <li>
        <p><code>main_page</code> (defaults to <code>Main Page</code>): the name of the page to display by
          default in the browser.</p>
        </li>
        <li>
        <p><code>templates_dir</code> (defaults to <code>Templates</code>): the directory to search for first
          when including pages only by name (as opposed to by fully qualified path).</p>
        </li>
        </ul>
        <h3><code>ignore</code> Section</h3>
        <p>This section defines more files or folders for Wikked to ignore (<em>i.e.</em> files
        that are not pages, or folder that don't contain pages).</p>
        <p>Each item in this section should be <code>name = pattern</code>, where <code>name</code> is irrelevant,
        and <code>pattern</code> is a glob-like pattern:</p>
        <pre><code>[ignore]
        venv = venv
        temp = *~
        temp2 = *.swp
        </code></pre>
        <p>This will ignore a <code>venv</code> folder or file at the root, or any file or folder
        anywhere that ends with <code>~</code> or <code>.swp</code>.</p>
Keywords: wiki mercurial hg git
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Environment :: Console
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
