parse2plone 0.6

Warning

This is a Buildout recipe! By itself it does nothing. If you do not know what Buildout is, please see: http://www.buildout.org/.

Getting started

Because it always drives me nuts when you have to dig for a recipe’s options, here they are:

[import]
recipe = parse2plone
#path = Plone
#html_extensions = html
#image_extensions = gif jpg jpeg png
#target_tags = a div h1 h2 p
#illegal_chars = _

Everything but the recipe parameter is commented out; the parameters listed are configured with default values. Uncomment/edit these if you would like to change the default behavior, they are (hopefully) self-explanatory. Now you can just cut and paste to get started, or keep reading if you would like to know more.

Installation

You can install Parse2Plone by editing your buildout.cfg file like so:

• First, add an import section:

  [import]
  recipe = parse2plone

• Then, add the import section to the list of parts:

  [buildout]
  ...
  parts =
      ...
      import

• Now run bin/buildout as usual.

Execution

You can run Parse2Plone like so:

$ bin/plone run bin/import /path/to/files

Demonstration

If you have a site in /var/www/html that contains the following:

/var/www/html/index.html
/var/www/html/about/index.html

You should run:

$ bin/plone run bin/import /var/www/html

And the following will be created:

• http://localhost:8080/Plone/index.html

• http://localhost:8080/Plone/about/index.html

Explanation

Why did you create Parse2Plone when the following packages (and probably many more) already exist:

• http://pypi.python.org/pypi/collective.transmogrifier

  • http://pypi.python.org/pypi/transmogrify.filesystem

  • http://pypi.python.org/pypi/transmogrify.htmlcontentextractor

Here are a few reasons:

• Because Parse2Plone is aimed at lowering the bar for folks who don’t already know (or want to know) what a “transmogrifier blueprint” is but can update their buildout.cfg file, run Buildout, and then run a single import command to import static content from the file system all without having to think very much.

• collective.transmogrify provides a framework for creating reusable pipes (whose definitions are called blueprints). Parse2Plone provides a single, non-reusable “pipe/blueprint”.

• The author had an itch to scratch; it will be nice for him to be able to say “just go write a script” and then point to an example.

Consternation

Here are some trouble-shooting comments/tips.

Modification

Modifying the default behavior of parse2plone is easy; use the command line options or add parameters to your buildout.cfg file.

Both approaches allow customization of the same set of options, but the command line arguments will trump any settings found in your buildout.cfg file.

$ bin/plone run bin/import /path/to/files --path=/path/to/Plone
$ bin/plone run bin/import /path/to/files -p MyPloneSite

[import]
recipe = parse2plone
path = Plone2
html_extensions = htm
image_extensions = png
target_tags = p

Communication

Questions, comments, or concerns? Email: aclark@aclark.net

History