source: branches/mbutscher/work/WikidPadHelp/data/WikiExport.wiki @ 195

Last change on this file since 195 was 190, checked in by mbutscher, 11 years ago

branches/mbutscher/work:
2.0beta02

  • Faster stop when closing WikidPad
  • Option to let selection in doc. structure automatically follow text cursor position in editor
  • Saved exports similar to saved searches
  • Wiki page files in UTF-16 encoding (with appropriate BOM) can now be read by WikidPad
  • Bug fixed: Wiki-wide search couldn't be opened if a functional page was in current editor
  • Bug fixed: Dialog to append/prepend wikiword failed
File size: 5.6 KB
Line 
1++ Wiki Export
2
3You can export your wiki as a single html page, a set of html
4pages, one wiki word page at a time, or as XML.
5
6You can select a few predefined operations from the "Wiki" menu:
7
8Export / Export Wiki As Single Html Page
9Export / Export Wiki As Set of Html Pages
10Export / Export Current Wiki Word As Html Page
11Export / Export Wiki As XML
12
13
14Or you can use Export / Other Export to show a dialog to choose other settings:
15
16*What to export*
17Choose if you want to export current page only, the current page and all sub-pages (children, grandchildren...), the whole wiki or use "Custom..." to open the [SearchingTheWiki#To search all pages: Full search|full search].
18
19*Compatible filenames*
20Uses ASCII-only filenames for exported files so that they can be transferred to other filesystems without compatibility issues. On Windows XP and Server 2003 the AppLocale utility (see http://www.microsoft.com/globaldev/tools/apploc.mspx ) might also help on export problems.
21
22*Export to*
23You can export a single HTML page, one HTML page for each wiki page, a [Multipage text format] file or a set of .wiki files (mainly interesting for Compact version to migrate to original).
24
25*Destination file/directory*
26Here you can set where the exported file(s) should be stored. If file or directory is needed depends on the type given in "Export to". For XML and multipage text it is a single file, for other types it is a directory (because multiple files must be written).
27
28
29When exporting as HTML all files in the file storage which are referenced by a relative URL (URL beginning with "rel://") in the exported pages are copied to a "files" directory in the destination directory. This does also apply to files in subdirectories of the "files" directory.
30
31
32*Saved exports*
33You can store your current export settings and retrieve them later to do the same export job repeatedly.
34
35*Save Export*
36Asks for a name for the current settings and saves it.
37
38*Delete Export(s)*
39Deletes one or more selected export(s) after confirmation.
40
41*Load Export*
42Loads export which is currently selected in list. Your previous settings made in the dialog are overwritten.
43
44*Load and Run Export*
45Same as first hitting "Load Export" then "OK" to start the export. Double-clicking on a saved export in the list does the same.
46
47
48
49+++ Additional options for HTML exports
50For the HTML exports you can choose if you want to:
51    * export URLs to images as \<img> tags or as normal links
52    * create a table of contents either as a tree or as a list.
53      For a single HTML page, the TOC is at the beginning of the
54      page, for a set of HTML pages, it is a separate
55      "index.html" file.
56      Using "As tree" is recommended when exporting the whole or
57      nearly the whole wiki, "As list" is better for small subsets
58      of a wiki as the tree option gives weird results here.
59   
60The defaults for these options can be set in the options dialog.
61
62
63+++ Additional options for .wiki file exports
64For the .wiki export you can choose if the files should have system encoding or UTF-8 with or without BOM (byte-order mark). The import function of Compact can't recognize UTF-8 without BOM correctly.
65
66
67+++ Additional options for multipage text format
68
69*Version*
70Choose which version the file should have. If you use version 1 it can be read only by WikidPad 1.9beta6 and later. Version 0 can also be read by earlier versions but looses information.
71
72*Write wiki func. pages*
73Store also wiki-bound functional pages in the file. Only available for format version 1 and later.
74
75*Write saved searches*
76Store also saved searches in the file. Only available for format version 1 and later.
77
78
79
80
81+++ Continuous export
82
83In menu "Extra" you can also choose "Continuous Export" which allows to start an export operation which is repeated automatically each time a page previously designated for export is modified.
84
85The dialog for continuous export is the same as for normal export, but some export types are missing as currently only the HTML export types support continuous export. Also some of the saved exports are hidden if they refer to exports not supported by continuous export.
86
87After you made your choices what and where to export and pressed "OK", WikidPad first makes an initial normal export. After that every change to a page is reflected in the export *after the page was saved to database* (manually or by auto-save).
88
89If you choose the menu item "Continuous Export" again (which has now a checkmark), the continuous export function is switched off again. It is also automatically deactivated if WikidPad is closed or another wiki is opened in the same window.
90
91A few drawbacks to mention:
92
93    1. Changes on a page that affect other pages (e.g. adding/removing attribute "\[global.camelCaseWordsEnabled: false]") will not change the already exported pages until they are re-exported.
94    2. The set of pages to export will be static under some circumstances. Especially if you start auto-export for all children of one or more pages, it will only export pages which were children when auto-export started regardless if new children are added later.
95    3. If you export as a single HTML file, the whole HTML file must be recreated on each change so it is only recommended if you export a few small pages.
96    4. If temporary (volatile) files must be created (e.g. generated from MimeTeX or GraphViz) there may be created new ones again and again on each change of a page filling up the "volatile" directory. Therefore it is recommended to make a final non-continuous export to clean up the garbage.
97
98
99
100
101
102
Note: See TracBrowser for help on using the repository browser.