add two modified version and documentation
[pyblosxom2wxr] / README
1 This repository has three branches with three different version of the
2 script.
3
4 I've run this twice and I've found that every PyBlosxom instance is a
5 little different and requires a different (sometimes very different)
6 version of this script. If you want to use it, you will *need*
7 to modify it to fit your needs. I've included three version of this
8 script in three different branches. Please use git to look at the three
9 to pick and choose what you want.
10
11 1. pyblosxom2wxr-snarfed.sh: This is the version available on
12    http://snarfed.org/pyblosxom2wxr
13
14    It assumes posts are .txt files which are HTML extension
15    and assumes both posts and pages as distinct types.
16
17 2. pyblosxom2wxr-revealingerrors.sh: coverted http://revealingerrors.com
18    
19    This assumes only posts, in .txt files, but which are all in fact
20    markdown files. It also takes into account 'tags' using the tags.py
21    plugin and assumes that they are the second line of every file
22    following a "#tags" line.
23
24    REQUIRES: markdown_py
25    
26 3. pyblosxom2wxr-copyrighteous.sh: converted http://mako.cc/copyrighteous
27
28    This deals with two types of files: .txt files which are standard
29    html pyblosxom files as well as .rst files which are restructured
30    text. It also looks for comma separated tags in the "#tags " line of
31    each file.
32
33    REQUIRES: python-docutils
34
35    HUGE WARNING: This version of the script changes the GUID or the
36    permalinks. It does *not* keep the links that worked with your old
37    version of PyBlosxom. I done because I usd date based URLS and I
38    wanted to get rid of them. The script *also* writes a new file,
39    called "url_mapping_list" in the local directory. I use that to set
40    up a series of 301 permanant redirects with Apache so that people
41    going to the old links still arrive at the page. 
42
43 Known Bugs / Workaround
44 -------------------------
45
46 One bug I have not worked around is that comments are created with the
47 'comment_author' field in the database including either the IP address
48 or the IP address and time timestamp pre-pended to the name. I think
49 this might be a bug in the Wordpress import code. Rather than debug it,
50 I wrote a simple perl script (fix_comment.pl) which will fix the
51 comments in the database. It's an ugly kluge but it worked for me.
52 Please read it carefully before running it.
53

Benjamin Mako Hill || Want to submit a patch?