Merge pull request #577 from davidjb/import-improvements-slug

Provide slug storage option for posts during Pelican import

docs/changelog.rst

@@ -9,6 +9,8 @@ Release history
 3.1 (2012-12-04)
 ================
 
+* Importer now stores slugs within files by default. This can be disabled with
+  the ``--disable-slugs`` option.
 * Improve handling of links to intra-site resources
 * Ensure WordPress import adds paragraphs for all types of line endings
   in post content

docs/importer.rst

@@ -39,29 +39,44 @@ Usage
 """""
 
 | pelican-import [-h] [--wpfile] [--dotclear] [--feed] [-o OUTPUT]
-|                [-m MARKUP][--dir-cat]
+|                [-m MARKUP] [--dir-cat] [--strip-raw] [--disable-slugs]
 |                input
 
+Positional arguments
+====================
+
+  input                 The input file to read
+
 Optional arguments
 """"""""""""""""""
 
   -h, --help            show this help message and exit
-  --wpfile              Wordpress XML export
-  --dotclear            Dotclear export
-  --feed                Feed to parse
+  --wpfile              Wordpress XML export (default: False)
+  --dotclear            Dotclear export (default: False)
+  --feed                Feed to parse (default: False)
   -o OUTPUT, --output OUTPUT
-                        Output path
-  -m MARKUP             Output markup
+                        Output path (default: output)
+  -m MARKUP, --markup MARKUP
+                        Output markup format (supports rst & markdown)
+                        (default: rst)
   --dir-cat             Put files in directories with categories name
+                        (default: False)
+  --strip-raw           Strip raw HTML code that can't be converted to markup
+                        such as flash embeds or iframes (wordpress import
+                        only) (default: False)
+  --disable-slugs       Disable storing slugs from imported posts within
+                        output. With this disabled, your Pelican URLs may not
+                        be consistent with your original posts. (default:
+                        False)
 
 Examples
 ========
 
-for WordPress::
+For WordPress::
 
     $ pelican-import --wpfile -o ~/output ~/posts.xml
 
-for Dotclear::
+For Dotclear::
 
     $ pelican-import --dotclear -o ~/output ~/backup.txt