This project imports WordPress XML dumps into refinerycms-blog.
The original repository is mremolt/refinerycms-wordpress-import
The shortcode processing came from zyphlar/wordpress-import
Keep in mind that links to other pages of your blog are just copied, as WordPress exports them as anchors. If your site (blog) structure uses new urls, the links WILL break! For example, if you used the popular WP blog url structure "YYYY-MM/slug", be warned that Refinery just uses "blog/slug". So your inner site links will point to the old WP url.
You will need an installation of refinerycms and refinerycms-blog. Make sure the site is running, all migrations are run and you created the first refinery user.
Add the gem to the Gemfile:
gem 'refinerycms-wordpress-import'
and run
bundle install
Use the Wordpress Export tool to export pages, posts, media, comments, tags and categories from your Wordpress site to an XML file.
Importing the XML dump is done via rake tasks in three stages, any of which are optional.
1. rake wordpress:reset_blog
2. rake wordpress:import_blog[file_name] *ONLY_PUBLISHED=1* *ALLOW_DUPLICATES=1* *SILENT=1*
3. rake wordpress:reset_and_import_blog[file_name] *ONLY_PUBLISHED=1* *ALLOW_DUPLICATES=1* *SILENT=1*
Task 1 deletes posts from Refinery blog tables along with their associated records (taggings, tags, blog_comments, blog_categories, blog_posts, blog_categories_blog_posts). This task is useful if you need to rerun the import process.
Task 2 parses the XML dump and imports blog posts, authors, comments, categories and tags into refinery tables. For more information about the content conversion process see Page and post conversion below.
The file_name parameter is the path to the dump file.
ONLY_PUBLISHED and ALLOW_DUPLICATES are optional environment variables you can use to control the import. SILENT suppresses all information messages
To avoid importing draft posts, set the ENV variable ONLY_PUBLISHED to any value.
To allow posts with duplicate titles set the ENV variable ALLOW_DUPLICATES to any value. (Refinery doesn't allow duplicate titles, so second and subsequent posts will have a counter attached to their regular title)
Example to skip all unpublished posts
rake wordpress:import_blog[file_name] ONLY_PUBLISHED=true
Task 3 combines the two previous tasks.
Three rake tasks manage the import into RefineryCMS Pages.
1. rake wordpress:reset_pages[offset_id]
2. rake wordpress:import_pages[file_name, offset_id, parent] *ONLY_PUBLISHED=1* *ALLOW_DUPLICATES=1* *SILENT=1*
3. rake wordpress:reset_and_import_pages[file_name, offset_id, parent] *ONLY_PUBLISHED=1* *ALLOW_DUPLICATES=1* *SILENT=1*
Parameters
file_name: (no default) the file name of the Wordpress XML dump file
offset_id: (default=0) An offset to add to the Wordpress page ids to ensure that there is no conflict with existing Refinery page-ids. If your highest Refinery page id is 55, you might set an offset_id of 100. (or 56)
parent: (no default) By default pages without a parent-id will be set to be top-level pages. To attach these pages as children of a specific page use the page slug.
ONLY_PUBLISHED and ALLOW_DUPLICATES are optional environment variables you can use to control the import. SILENT suppresses all information messages.
To avoid importing draft pages set the ENV variable ONLY_PUBLISHED.
To allow posts with duplicate titles set the ENV variable ALLOW_DUPLICATES.
(Refinery doesn't allow duplicate titles so second and subsequent posts will have a post-id attached to their regular title)
Tasks
Task 1 deletes pages from the Refinery CMS, enabling a clean import. If you have Refinery pages you wish to keep use the offset_id parameter to specify a lower_limit on page_ids to be deleted.
Task 2 imports WordPress pages into Refinery. If an offset_id has been given all pages will have the offset value added to their Wordpress page-id. The page parent-child structure is preserved. For more information about the content conversion process see Page and post conversion below.
To skip unpublished pages add the ONLY_PUBLISHED parameter to this task.
To allow duplicate page titles add the ALLOW_DUPLICATES parameter to this task.
Task 3 Cleans and import pages in a single step.
Example: to import the Wordpress pages attach the imported Wordpress pages as the children of the home page. All the pages will have 100 added to their Wordpress page_ids.
rake wordpress:import_pages[file_name, 100, 'home']
Example: import published pages with their original page-ids unchanged.
rake wordpress:import_pages[file_name] ONLY_PUBLISHED
Task 3 combines Tasks 1 and 2 into a single step.
For a succesfull media import the site with the media URLs must still be online. The gem downloads the files from the old site and imports them into Refinery. THis step must happen after the pages and posts have been imported so that new file urls can be added to the content.
The Wordpress XML dump contains absolute links to media files linked inside posts, like:
www.mysite.com/wordpress/wp-content/uploads/2011/05/cv.txt
After the files have been imported, the gem replaces the old links in pages and blog posts with the newly generated links to the Refinery site. It parses all existing records searching for the old URLs. For this to work you must import pages and posts FIRST to get the URLs replaced.
Tasks
1. rake wordpress:reset_media[offset_id]
2. rake wordpress:import_media[file_name]
3. rake wordpress:reset_and_import_media[file_name,offset_id]
The first task deletes records from the Refinery media tables (Refinery::Images, Refinery::Resources). To keep existing images in the Refinery database use an offset_id to limit record deletion to ids higher than the offset.
Note: This task is useful if you are repeating an import and want to remove previously imported files, but leave Refinery images and resources intact.
The second task imports the Wordpress media into Refinery. This task downloads files from the old site so may take some time. After the import it parses all pages and blog posts, replacing the old URLs with the current refinery ones. Wordpress attachment ids are not used so there should be no conflict with Refinery images and resources.
The third task allows you to clean and import in one command.
Finally, if you want to reset and import all data including media:
rake wordpress:full_import[file_name, page_offset_id, parent, media_offset_id] *ONLY_PUBLISHED=1* *ALLOW_DUPLICATES=1*
One more hint for users of zsh
The square brackets following the rake task need to be escaped on zsh, as they have a special meaning there. So the syntax is:
rake wordpress:reset_and_import_blog\[file_name\]
Ugly, but it works. This is the case for all rake tasks.
During page and post conversion some shortcodes and other special features are recognized and changed.
Paragraphs
Wordpress doesn't export <p> tags. Paragraphs are separated by a blank line. The conversion process looks for these and wraps the text in <p> tags.
Base64 encoded images
Some content has been noted which includes base64 encoded images. These appear as a single line of 500K or more characters which the rest of the content processing seemed to struggle with. These images are processed and saved as files in the public folder, and an appropriate url is inserted into the text before other formatting is done.
Shortcodes
Shortcodes are processed using the Shortcode gem and template files located in support/templates/haml. You may wish to add templates for frequently occurring shortcodes in your Wordpress site or change the generated markup in existing templates. Below are the currently recognized shortcodes with examples of the conversion that is done. The generated markup is what has been needed by people who have worked on this gem at various times.
caption
[caption id="attachment_304" align="alignright" width="300" ]
<img class="size-medium wp-image-304" title="Image Title" src="http://example.com/blog/wp-content/uploads/2011/10/image.jpg" alt="There is an image here" width="300" height="198"style="padding-left:20px" />
Here is an image
[/caption]
<figure class="alignright">
<img class="size-medium wp-image-304" title="Image Title" alt="There is an image here" src="http:/refineryeg.com/dragonflyencodingimage.jpg" />
<figcaption>Here is an image</figcaption>
</figure>
column
[column width="47%" padding="0"] foo [/column]
<div class="post_column_1">
end_columns
[end_columns]
<div style="clear: both;"></div>
google-map-v3
[google-map-v3] I don't use this shortcode and haven't tested it. It adds an iframe with a google map code.
quote
[quote author="Fred Dagg"]Fair words butter no parsnips.[/quote]
<blockquote>
<p class='quotation'>Fair words butter no parsnips.
<p class='citation'><span class="author">Fred Dagg</span></p>
</p>
</blockquote>
ruby
[ruby]p "Hello Word"[/ruby]
<pre class="brush: ruby">p "Hello world"</pre>
youtube
[youtube id='youtubeid' width='300' height='400]
[youtube youtubeid 300 400]
<p>
<iframe width=300 height=400 frameborders=0 type='text/html' class='youtube-player'
src='http://www.youtube.com/embed/youtubeid?version=3&rel=1&fs=1&showsearch=0&showinfo=1&iv_load_policy=1&wmode=transparent'>
</iframe>
</p>
###Adding and modifying shortcode conversions
Shortcode templates are processed by the Shortcode gem.
The gem is initialized in lib/wordpress/page.rb and the templates are in the directory support/templates/haml.
Modify a template by editing the template file.
To add a template you need to add its name to the list of templates in the initialization code and supply a suitable template file.
Follow the examples already there and find further documentation with the Shortcode gem.
Welcome.