Skip to content

Commit 220d27b

Browse files
committedJul 12, 2015
Fixed typo in changes and rewrote docu.
1 parent 902fbd6 commit 220d27b

File tree

2 files changed

+35
-13
lines changed

2 files changed

+35
-13
lines changed
 

Diff for: ‎CHANGES.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Features
1818
* Allowing to use WordPress page compiler on imported site instead of
1919
converting posts to markdown with --use-wordpress-compiler
2020
* Allowing to automatically install the WordPress page compiler when
21-
needed with --install_wordpress_compiler
21+
needed with --install-wordpress-compiler
2222
* Exporting information on attachments per post as JSON
2323
* Exporting post status and excerpt
2424

Diff for: ‎docs/manual.txt

+34-12
Original file line numberDiff line numberDiff line change
@@ -1910,23 +1910,45 @@ the following:
19101910

19111911
* Allows you to export your comments with each post
19121912
* Exports information on attachments per post
1913-
* Will try to convert the content of your posts. This is *not* error free, because
1914-
WordPress uses some unholy mix of HTML and strange things. Currently we are treating it
1915-
as markdown, which does a reasonable job of it.
1913+
* There are different methods to transfer the content of your posts:
19161914

1917-
You will find your old posts in ``new_site/posts/post-title.md`` in case you need to fix
1918-
any of them.
1915+
- You can convert them to HTML with the WordPress page compiler plugin
1916+
for Nikola. This will format the posts including supported shortcodes
1917+
the same way as WordPress does. Use the ``--transform-to-html`` option
1918+
to convert your posts to HTML.
19191919

1920-
You can also use a page compiler based on WordPress code which is available as a plugin.
1921-
The importer allows you to use this page compiler to transform the posts directly on
1922-
import to HTML files, or to export them without modifications. Please note that since
1923-
WordPress is licensed under the GPL, so is the page compiler plugin.
1920+
If you use this option, you do not need to install the plugin
1921+
permanently. You can ask Nikola to install the plugin into the subdirectory
1922+
``plugins`` of the current working directory by specifying
1923+
the ``--install-wordpress-compiler`` option.
19241924

1925-
The page compiler currently only supports the ``[code]`` shortcode, but other shortcodes
1926-
can be supported via plugins.
1925+
- You can leave the posts the way they are and use the WordPress page
1926+
compiler plugin to render them when building your new blog. This also
1927+
allows you to create new posts using the WordPress syntax, or to manually
1928+
add more shortcode plugins later. Use the ``--use-wordpress-compiler``
1929+
option to not touch your posts.
1930+
1931+
If you want to use this option, you have to install the plugin permanently.
1932+
You can ask Nikola to install the plugin into your new site by specifying
1933+
the ``--install-wordpress-compiler`` option.
1934+
1935+
- You can let Nikola convert your posts to Markdown. This is *not* error
1936+
free, because WordPress uses some unholy mix of HTML and strange things.
1937+
This is the default option and requires no plugins.
1938+
1939+
You will find your old posts in ``new_site/posts/post-title.html`` in the first case,
1940+
``new_site/posts/post-title.wp`` in the second case or ``new_site/posts/post-title.md``
1941+
in the last case if you need to edit or fix any of them.
1942+
1943+
Please note that the page compiler currently only supports the ``[code]`` shortcode,
1944+
but other shortcodes can be supported via plugins.
1945+
1946+
Also note that the WordPress page compiler is licensed under GPL v2 since
1947+
it uses code from WordPress itself, while Nikola is licensed under the more
1948+
liberal MIT license.
19271949

19281950
This feature is a work in progress, and the only way to improve it is to have it used for
1929-
as many sites as possible and make it work better each time, so I am happy to get requests
1951+
as many sites as possible and make it work better each time, so we are happy to get requests
19301952
about it.
19311953

19321954
.. [#] The dump needs to be in 1.2 format. You can check by reading it, it should say

0 commit comments

Comments
 (0)