forked from stephanieleary/HTML-Import-2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
218 lines (178 loc) · 14.2 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
=== HTML Import 2 ===
Contributors: sillybean
Donate link: http://sillybean.net/code/wordpress/html-import-2/
Text Domain: html_import
Domain Path: /languages
Tags: import, pages, static files, taxonomies, taxonomy, dreamweaver, Word, FrontPage
Requires at least: 3.0
Tested up to: 4.6
Stable tag: 2.6
Imports well-formed HTML files into WordPress pages.
== Description ==
Imports well-formed static HTML files into WordPress. Requires PHP 5.
This plugin will import a directory of files as either pages or posts. You may specify the HTML tag (e.g. `<body>`, `<div id="content">`, or `<td width="732">`) or Dreamweaver template region (e.g. 'Main Content') containing the content you want to import.
If importing pages, the directory hierarchy will be preserved. Directories containing the specified file types will be imported as empty parent pages (or, if an index file is present, its contents will be used for the parent page). Directories that do not contain the specified file types will be ignored.
As files are imported, the resulting IDs, permalinks, and titles will be displayed. On completion, the importer will provide a list of Apache redirects that can be used in your `.htaccess` file to seamlessly transfer visitors from the old file locations to the new WordPress permalinks. As of 2.0, if you change your permalink structure after you've imported your files, you can regenerate the redirects—the file's old URL is stored as a custom field in the imported post.
Options:
* import files into any post type (posts, pages, or custom post types set to `public`)
* import linked media files (images, documents, etc.) to the media library
* select content, title, and custom fields by HTML tag or Dreamweaver template region
* remove a common phrase (such as the site name) from imported titles
* remove the imported title from within the content area
* upload a single file or scan a directory for files to import
* specify file extensions to import (e.g. html, htm, php)
* specify directories to exclude (e.g. images, css)
* if importing pages (or any hierarchical post type), specify whether your top-level files should become top-level pages or children of an existing page
* specify index file names (e.g. index.html, default.htm) whose contents should be used for the directory parent pages
* set tags, categories, and custom taxonomies
* choose status, author, and timestamp
* use meta descriptions as excerpts
* clean up imported HTML and strip unwanted tags and attributes in content and custom fields
* fix internal links in imported files to match new permalinks
* import the entire file and generate the title from the filename
* preserve the original filename as the imported page's slug
* choose the date from an HTML tag or Dreamweaver region (uses <a href="http://php.net/strtotime">strtotime()</a>; results may vary)
* import additional HTML tags or Dreamweaver regions as custom fields
* option to remove imported title from within content area
* fallbacks: if your chosen tag/area is empty or does not exist, the importer will select `<body>` for content and `<title>` for the title
* use a custom field named 'post_tag' to import tags from a portion of the file
See the <a href="http://stephanieleary.com/code/wordpress/html-import/html-import-2-user-guide/">User Guide</a> for details on all the options.
== Installation ==
1. Unzip the files and upload the plugin directory to `/wp-content/plugins/`
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Go to Settings → HTML Import to begin. You must save the settings before proceeding to Tools → Import → HTML.
== Frequently Asked Questions ==
= My title imported, but the content was empty! (Or vice versa.) =
You didn't find the right HTML tag that surrounds the content you wanted to import. Open up one of your old files in a browser and use its inspector (or Firebug) to select the content you want. Look for the tag that surrounds that content and find something unique about it. (An ID attribute is best, but anything <em>unique</em> will work. If it's a table cell, a unique width will do just fine.) The enter the tag name, the attribute name, and the attribute's value into the separate boxes in the Content section of the importer's options page.
See the <a href="http://stephanieleary.com/code/wordpress/html-import/html-import-2-user-guide/">User Guide</a> for details and examples.
= Does this work on Windows servers? =
Yes! Let me know if you encounter any problems.
= Will the importer duplicate the design of my old site? =
No. The importer simply extracts the relevant part of each HTML file and copies it into a WordPress post. You'll need to <a href="http://codex.wordpress.org/Theme_Development">create a custom theme</a> if you want to preserve the site's appearance as well as its content.
= Will this work on large numbers of HTML files? =
Yes, it has been used to import over a thousand pages, and did so in a couple of minutes. However, you might need to adjust PHP's `max_execution_time` setting as described below.
= I import a few files and then the script times out. What can I do? =
The importer will attempt to work around your server's `max_execution_time` setting for PHP (usually 30 seconds), but some servers don't allow this. You can try to increase it by adding a line to your `.htaccess` file:
`php_value max_execution_time 160`
If that gets you further but still doesn't finish, just increase the number (it's in seconds). However, note that your host might get irritated with you for hogging the server's resources. If you have a _lot_ of files to import, it's best to install WordPress on your desktop (XAMPP for Windows and MAMP for Macs make it pretty easy) and run the importer there instead of doing it on your live server.
It's also quite possible that the script is trying to use more memory than your server allows. You can try to change that setting, too, in `.htaccess`:
`php_value memory_limit 1024M`
= Should I remove 'images' from the list of skipped directories if I want to import images? =
The skipped directory setting just tells the importer where to look for HTML files. Linked images will be imported no matter where they're located.
= Can I import files from another server? =
No. The files must be on the same server as your WordPress installation. I have no intention of ever making this plugin import files from URLs. You are welcome to fork the code if you want to add this feature.
== Changelog ==
= Contribution from rpeyron =
* Added French translation and translation fixes
* Added '*' for all document types
* Added option to import media files in original folder structure
* Added option to prefix import path
* Added redirects for imported media files
= 2.6 =
* Removed ancient magic runtime quotes call, wow.
* Checking for empty string instead of empty() to allow for directories named '0' or similar
* Bail out earlier if XML can't be loaded, to avoid fatal errors
* More efficient link rewriting
= 2.5.1 =
* Fixed warnings and notices related to the custom category walker.
* Fixed bug where the page parent option displayed incorrectly in sites with no published pages.
= 2.5 =
* Custom fields can now allow the same HTML tags as content
* Fixed a problem with some image paths
* Made image and link searches case-insensitive (props <a href="https://profiles.wordpress.org/noamcleanforestsolutionscom/">Clean Forest Solutions</a>)
* Fixed some incorrectly escaped options that would trigger translations on things that shouldn't be translated
* Page template selections are now pre-selected when returning to the options page (props <a href="https://profiles.wordpress.org/lee-fent/">Lee Fent</a>)
= 2.4 =
* You can now specify more than one index filename (e.g. 'index.php, default.htm')
* New option to remove the imported title from within the content area
* Fallbacks: if your chosen tag/area is empty or does not exist, the importer will select `<body>` for content and `<title>` for the title. As a last resort, if there is no title, the original file name will become the title.
* You can now use a custom field named 'post_tag' to import tags from a portion of the file
* UI fixes for the custom fields tab
* Bug fix: the importer now correctly recognizes absolute links to images
= 2.3 =
* New option to import an entire file's contents instead of selecting a portion of it. (Props Shawn Zilbert.)
* New option to generate the title from the filename. (Props Shawn Zilbert.)
* New option to preserve the original filename (minus the extension) as the imported page slug. (Sponsored by <a href="http://www.nycinsiderguide.com">NYCinsiderguide.com</a>)
* New option to choose the date from an HTML tag or Dreamweaver region.
* New option to import custom fields.
* UI cleanup. The tabs should work a bit better.
* "asXML() on a non-object" errors should be less frequent now.
* Fixed a problem with file types that would cause blank thumbnails and images. (Props <a href="http://wordpress.org/support/topic/plugin-html-import-2-importing-images-to-media-fix?replies=3">mchev2 and Carsten Bach</a>.)
= 2.2 =
* Now imports media files other than images. Uses `rawurldecode()` to remove junk like `%20` from file names, and thus should now handle situations where your link is something like `my%20file.doc` and your file is actually called `my file.doc`.
* Now handles images with https srcs.
* Removed a pointless security check that was preventing people from uploading valid image files.
= 2.1 =
* New option to fix internal links. Also, the importer now bakes you cookies. (Kidding about the cookies.) (August 23, 2011)
= 2.0.2 =
* Added some helpers to work around servers that do not support PHP's multibyte string functions. (August 12, 2011)
= 2.0.1 =
* Added option to set the page template for hierarchical post types. (August 2, 2011)
= 2.0 =
* New option to import images linked in the imported HTML files. It can handle most relative paths as well as absolute URLs. The report includes a list of the image paths that couldn't be found.
* Now supports all public custom post types and taxonomies (including hierarchical ones).
* Completely different, much better handling of special characters.
* The import screen now lets you upload a single file.
* New user interface. The options form is now broken up into several tabbed sections. Categories and other hierarchical taxonomies are selected with checkboxes.
* The options form is now separate from the importer. It will now check your settings before the importer runs -- for example, you'll get a warning if your beginning directory isn't readable.
* The importer itself is now based on the WordPress import class, which means it looks and works more like other importers. It is located under Tools→Import (but you should visit the settings screen first).
* Files' old URLs are now stored as custom fields in the imported posts. There's now an option to regenerate the redirects for your imported files, which is handy if you changed your permalink structure after you finished importing.
* When importing directories as hierarchical post types (like pages), the importer now uses the default directory file (like index.html) for the parent page's contents.
* Now skips Dreamweaver `_notes` and Frontpage `_vti_cnf` directories automatically.
* Now makes proper use of the Settings API for better security and data validation.
* Help screen and <a href="http://sillybean.net/code/wordpress/html-import-2/user-guide/">user guide</a>.
* Now requires at least WP 3.0. (July 15, 2011)
= 1.30 =
* The '.,..' directories are no longer optional, so you can't accidentally import hundreds of empty posts/pages by removing these from the skipped directories option.
* The beginning directory default is now based on the path to your WordPress installation. There's also a hint shown below the field. This should help people locate their import directory correctly.
* There's now an option to enter your old URL. If you enter it, your .htaccess redirects should work as displayed. If you leave it blank, you'll have to doctor the paths afterward, as before.
* Character encoding is now optional. If your special characters did not import correctly before, try again with this option unchecked (which is now the default).
* Options are now deleted on plugin uninstall instead of deactivate. (Sorry about that.)
* Code cleanup in preparation for version 2.0. (June 24, 2011)
= 1.21 =
* same as 1.2; not sure why the plugin repository can't count
= 1.2 =
* Added custom taxonomy options
* Better handling of mb encoding function and asXML
* Better security checking
* Added translation support (January 24, 2010)
= 1.13 =
* Fixed a bug in 1.11 when importing content specified by a tag (thanks, mjos)
* Added an option to assign a category or tag to all imported posts
* This is 1.12, only uncorrupted (September 13, 2009)
= 1.12 =
* Fixed a bug in 1.11 when importing content specified by a tag (thanks, mjos)
* Added an option to assign a category or tag to all imported posts (September 13, 2009)
= 1.11 =
* Left some debugging code in 1.1, oops! (August 15, 2009)
= 1.1 =
* Added Word cleanup option (August 14, 2009)
= 1.04 =
* Better user capability check (August 3, 2009)
= 1.03 =
* Still better error handling
* minor code cleanup (August 1, 2009)
= 1.02 =
* Better error handling for `fopen` and `file_get_contents` (July 31, 2009)
= 1.01 =
* jQuery bug fixed
* better Windows compatibility (July 31, 2009)
= 1.0 =
* First release (July 26, 2009)
== Other Notes ==
= Thanks =
Thanks to...
* Tom Dyson's <a href="http://wordoff.org/">Wordoff.org</a> for inspiring the Word cleanup option in 1.1.
* Dion Hulse's <a href="http://wordpress.org/extend/plugins/add-from-server/">Add from Server</a> plugin and bbqiguana's <a href="http://wordpress.org/extend/plugins/add-linked-images-to-gallery-v01/">Add Linked Images To Gallery</a> plugin, from which I borrowed a lot of the logic behind the image import feature in 2.0
== Screenshots ==
1. Settings for files to import
2. Content settings
3. HTML cleanup options
4. Title and metadata settings
5. Alternative title specifications
6. Custom field settings
7. Category, tag, and taxonomy settings
8. Import screen (directory/file selection)
9. Completed import: pages, rewrite rules, and images
10. Sample directory and file structure
11. The same site, after the import (directory hierarchy preserved as parent/child pages)