source: branches/mbutscher/work/WikidPadHelp/data/Multipage text format.wiki @ 195

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

2.0preAlpha (internal)

Works so far, now editing help wiki.

File size: 2.5 KB
Line 
1++ Multipage text format
2
3This format is intended to save and transfer a set of pages as a single, human readable and editable text file.
4
5The file must be encoded either as UTF-8 with appropriate byte-order-mark or use the default system encoding of the operating system. The exporter always generates UTF-8 files.
6
7
8If the *first line* starts with
9
10#!
11
12it is ignored. This will later allow to handle these text files as a kind of Unix shell scripts which can be imported just by "executing" them. Currently the exporter doesn't generate such a line and there is no commandline option to run the importer.
13
14
15The *first header line* (which might be the actual second line, see above) consists of "Multipage text format " followed by a number. This identifies the file as mpt file. The number gives the format version. Currently this whole line has to be:
16
17Multipage text format 0
18
19or
20
21Multipage text format 1
22
23The *second header line* starts with "Separator: " followed by arbitrary characters. The characters define the separator line which will then be used to separate the wiki pages (and other items) from each other. Therefore the wiki pages included in the multipage text file must not contain such a line as normal text.
24
25The *exporter tries to construct this separator* by creating 25 random alphanumeric ASCII characters enclosed by five dashes left and right, e.g. "-----s6ngFAIHeY6QewI4Bq26i6E3m-----". The exporter tries 15 of such random strings.
26If all these exist already, it gives up with an error message ("No usable separator found").
27
28
29+++ Format version 0
30
31After the header the actual pages begin. Each page consists of a line with its name (=the wiki word) followed by lines of content as they are shown in WikidPad. It ends either by the end of file or by a separator line (see above).
32
33
34+++ Format version 1
35
36After the header the actual pages begin. The first line defines which item is defined here. If the name starts with "funcpage/" it is a functional page, the content follows. If it starts with "savedsearch/" it is a saved search, the content is binary and encoded as base64.
37
38If the name starts with "wikipage/" it is a wiki page, the name of the page follows on the same line. The next line contains three dates separated by each other by two spaces "  ". Each date is formatted YYYY-MM-DD/hh:mm:ss. The first date is the modification date of the page, second is the creation date, third will become the last visit date (currently not supported).
39
40
Note: See TracBrowser for help on using the repository browser.