parent nodes: DemoExternalLinks | DemoFilesWikiFileStoreIp

Demo Files Wiki File Store

Contents:
Demo Files Wiki File Store
General
Copy control
Manual control
HTML export
Remarks
Todo
Results

General

Each wiki can have a "file store", where you can collect all the images, documents and other files, that are related to the wiki in one place. The wiki file store is formed by the "files" folder in the wiki's directory. Wikidpad offers some special facilities, to help maintain the file store, with respect to relative links and export to html.

Files can of course be copied into the file store by hand; if the "files" folder does not yet exist, you have to create it first. Files can however also be copied, by dragging one or more of them from Windows Explorer onto the editor, while holding down the control key. The files are then copied to the file store and relative links to them are created in the editor. If a file with the same identity already exists in the store, only the link is created and no copying is performed. If a file with the same name, but a different identity already exists, a random sequence of 10 digits is appended to the file name, in order to make it unique. If the "files" folder does not yet exist, Wikidpad will create it.

For more information on how Wikidpad compares files and how you that can be influenced, see Wiki File Store: Copy control

Top

Copy control

When copying a file to the file store, Wikidpad checks the store for one or more files with the same identity. These do not specifically have to be files with the same name! Files with different names, can still be (copies of) exactly the same image or document. For files to be seen as identical, they must have:
  1. The same size
  2. The same suffix (or extention = the part of the filename from the last dot to the end of the name)
During identity control, all the files that fullfill these conditions, are put on the shortlist of possibly identical files. The size of the shortlist can be influenced, using the following two options:[1]
  1. Modified date must match
    - Only files with the exact same modification date are accepted for the shortlist. This option speeds up the identity check, but may lead to unnecessary copies of the same file in the store.
  2. File name must match
    - Only files with the exact same name are accepted for the shortlist. This option is not extremely useful, but can have it's use.
Furthermore, the comparison process can be influenced with the option:[1]
  1. Modified date is enough
After the shortlist is completed, it is compared against the file to be copied in the following sequence:
  1. If the list contains a file with the exact same name, this file is condsidered to be the same file.
  2. If modified date is enough = true
    1. If the list contains one (1) file with the exact same modification date, this file is considered to be the same file.
    1. If the list contains more of those files, then the (first) file with the same content is considered to be the same file.
    1. If there is no such file or no file has the same content, then the process continues with bullet 4.
  3. Modified date is enough = false
    1. If there are files in the list, that have the same modification date, then the (first) file with the same content is considered to be the same file.
    1. If there is no such file or no file has the same content, then the process continues with bullet 4.
  4. The (first) file with the same content, is considered to be the same file.
  5. If there is no such file, then there is no file in the store, that is the same.
Important! Top
[1] These options can be set in "menu / wiki / options / page: current wiki

Manual control

Other directories than "files" and "data" can be created in a wiki's directory and files in them can be referenced using relative links, but only the "files" directory is managed by the file store mechanism.

The file store has no special status, as far as the operating system is concerned. Files and folders can be copied, moved and deleted to and from the folder manually, as usual. This should however be avoided at moments, when Wikidpad is performing copy control activities on the file store.

The file store "copy" can't copy or create subdirectories into the file store; you can do that manually. Copy control however will not search these subdirectories for identical files.

Wikidpad never deletes a file in the store; not even when there is no reference to it anymore in any of the pages of the wiki. As far as this type of "housekeeping" is necessary for the file store, it has to be done manually.

Top

HTML export

When exporting pages to html, all the files in the file store, that are referenced in those pages and use a rel scheme for the link (i.e. relative link of relative path) are copied into a "files" subfolder of the export target folder. Doing this, Wikidpad will respect any folderstructure, that might have been created in the "files" folder and that contain files, that are referenced by the exported pages. So a referenced file: will be copied to: Files that are in the file store, but are referenced using absolute links, will not be copied to the target folder's file store. Files that are referenced with relative links, but are in a wiki subfolder different from the file store, are also nót copied to the export target. And of course files that are in folders outside the wiki folder, are not copied either. As far as any of these files is referenced using a relative liks, it's the user's responsibility, to copy these files to their correct target folders.

Top

Remarks

Top

Todo

todo.demo.projectdemo.demo1: check out all posibilities
todo.demo.projectdemo.demo1: check correctness of text

action.demo.development: check out copy control options not being mutually exclusive.
Is this by design or overlooked? How does wikidpad respond, when more then 1 option is checked?
question.demo.development: does modification date include modidication time?
question.demo.development: is the sequence of copy control correct: bullet 2?
see remarks; third bullet

Top

Results

issue.demo.new: copy control options not mutually exclusive

[demo.status.waiting: issues]
Top
previous: Back
parents:  DemoExternalLinks, DemoFilesWikiFileStoreIp
inserts:   DemoFilesWikiFileStoreIp
attributes: [tree_position: 2], [template: DemoSubjectTemplate], [camelCaseWordsEnabled: false]