<< March 2017 >>
Sun Mon Tue Wed Thu Fri Sat
 01 02 03 04
05 06 07 08 09 10 11
12 13 14 15 16 17 18
19 20 21 22 23 24 25
26 27 28 29 30 31

If you want to be updated on this weblog Enter your email here:

rss feed

Dec 11, 2016
The iHelp
', '[[Special::TOC]] [[Include::Beta testing]] = Welcome to Wiki on a Stick! Wiki on a Stick (*WoaS*) is a [[http://en.wikipedia.org/wiki/Wiki|wiki]] that lives in *one self-modifying XHTML file*. It's perfect for use at home or office, on your laptop or USB pen drive. Woas can be used as a personal notepad, calendar, repository for software documentation, and for many other purposes; it allows full customization and extension by your own macros, scripts, and plugins, and pages can even be protected with [[WoaS::Help::Security|AES encryption]]. == This /Woas/ Version This version of WoaS is based on v0.12.0 but has been modified by Paul Levey ([[http://pvhl.users.sourceforge.net/|pvhl]]) to fix various bugs present in the official 0.12.0 release and to generally improve the overall look and functionality of WoaS. I call my version /Woas/, and give it a different logo so it can be recognized as different from the official releases. The changes I have made represent many hundreds of hours of work, including repeatedly cross-checking on many different browsers to achieve the same results across them all (a patch file between the two versions is about 750k!). The improvements range from a greatly improved /Search/ page, to a little padding in the editor textarea. It also uses a new layout system that allows section jumps to appear where they should, and a fixed header that doesn't jump around with changing content length. And it stays consistent at all text sizes, an important point for myself. Though I've never seen it on a handheld device, I have tested it on a little 7 inch ASUS and it worked very well, so it ought to be fairly usable on smaller devices. This version is well tested, and I use it for all my research -- though we all need to keep backups, right? (An excellent way to use Woas is from a DropBox folder.) It is expected that many of these changes will some day make their way into the official code. The latest released version of this file can be found at my [[http://woas.sourceforge.net|Woas development project]], and the 'bleeding-edge' code is at [[|my GitHub account]] (only recommended for helping with development, or creating your own version). It is a simple matter to import any content you have in other WoaS files using the [[Special::Import|import page]]. My thanks to [[http://bookonastick.wordpress.com/|Little Girl]] for her extensive work on the Help pages, the majority of whose content was written by her, and for her help with testing, and to various others for encouragement and help with testing. == Official Versions Versions 0.9˜0.12.0 by Daniele C. ([[http://sf.net/users/legolas558/|legolas558]]) Original version (v0.01 ˜ v0.04) by André Wagner == License While the WoaS project is released under the GNU/GPL license, my /Wiki on a stick/ work is licensed under the more recent, but compatible, [[Special::License|GNU Affrero license]]. = Project Interaction == Websites The official website for this, my personal version of Woas, is at [[http://woas.sourceforge.net|my Woas project]]. The official WoaS website is [[http://stickwiki.sourceforge.net|here]]. === /Everything below is from the original 0.12.0 version./ == Download Wiki on a Stick can always be downloaded through the official SF.net WoaS project file download service: [[https://sourceforge.net/projects/stickwiki/files/|Download Wiki on a Stick]] == Get support You can use the [[http://woas.iragan.com/|official WoaS forums]] and the [[http://sf.net/projects/stickwiki/|SF.net WoaS project facilities]]. == Important links * [[http://sf.net/projects/stickwiki/|SourceForge project home page]] - useful for getting the latest files and contributing to the project. * [[http://woas.iragan.com/|Official WoaS forums]] - our discussion forums where you can also participate in the decision processes * [[http://sourceforge.net/tracker/?group_id=155218&atid=794925|SF.net WoaS project bug tracker]] - if you find a bug, post it here * [[http://sourceforge.net/tracker/?group_id=155218&atid=794928|SF.net WoaS project feature tracker]] - if you have have a suggestion for improvement, post it here * [[http://www.iragan.com/woas_irc/|Official WoaS IRC Channel]] - #woas room at FreeNode servers * [[https://lists.sourceforge.net/lists/listinfo/stickwiki-devel|SF.net WoaS Development mailing list]] - for discussion of WoaS development = Appreciation This project wouldn't be what it is without the help of many people. If you contributed to Wiki on a Stick and your name is not here (or if you do not want it to be listed here), please [[http://sourceforge.net/sendmessage.php?touser=799761|contact the maintainer]]. * *Jeremy Ruston* - the creator of the wonderful [[http://www.tiddlywiki.com/|TiddlyWiki]] that served as inspiration for Wiki on a Stick. * *Philip O'Donnel* - the creator of the table syntax and parsing code. * *Tim Lord* * *Knut Kohl* * *Rob Schmersel* * *Michiel van Everdingen* - [[http://home.versatel.nl/MAvanEverdingen/Code/|original JavaScript implementation]] of AES encryption * *Cyril Mazard* - search feature * *jimmac* - author of [[http://jimmac.musichall.cz/i.php?i=gorilla-stock|the icon set]] that we are currently using in WoaS * *martinellison* - transclusion patch * *Nilton Castillo* - bug fixes and enhancements (original pluggable macro syntax) * *Little Girl* - assistance with documentation, overall testing, and various improvements * [[http://weekendtesting.com/archives/833|Europe Weekend Testing]] - provided a testing session for WoaS * [[http://testconsultant.blogspot.com/|Jeroen Rosink]] - testing of WoaS releases', '= Search in Wiki    


*Search Type:*  


', '
== AES encryption Read more about the [[WoaS::Help::Security|embedded AES encryption]] used in Wiki On a Stick. == Password Enter your password for AES encryption. The more complex your password is, the more difficult it will be to attack the encryption. It is suggested *not* to use passwords whose textbox color is  red , and to accept passwords only when the textbox color is  green . Punctuation and Mixed case characters will exponentially increase the strength of your password.
\ ', '== AES encryption [[http://en.wikipedia.org/wiki/Advanced_Encryption_Standard|AES]] 256-bit high security data encryption standard is supported to protect a single page or groups of them. WoaS has two different interfaces for encryption passwords, namely one for encryption (called *Locking*) and one for decryption (called *Unlocking*). == Encryption The page encryption interface shows a colored meter for estimated password quality; the encryption password is not stored in your saved files (true AES encryption is used). <<_note *If you forget the password there is no way to retrieve it or your data.*>> Click on the /lock/ icon in the navigation bar to encrypt the page being viewed. The page locking interface has two password boxes (the second for verification); the background color of the first box provides a hint about estimated password strength. Once you've chosen and typed in your password, click the *Lock* button to encrypt the page. When encrypting additional pages during a session, you'll be offered to use the same password you used to encrypt the first page. Accept by pressing the *OK* button or decline by pressing the *Cancel* button. If you decline, the password interface will open, allowing you to set a new password for the page. There is no limit to how many passwords you can use. == Decryption Click the *Set password* icon in the navigation bar to set the decryption password used for the next page. The password for decrypting a page (or pages) is cached so that you only need to enter it once per session. If you close or reload the wiki, you will need to reenter the password to work with the encrypted page(s). To disable the password cache, check the box for *Do not temporarily cache the AES key* in the wiki [[WoaS::Help::Special::Options|Options]]. If you've used more than one password for encrypting your pages, you'll need to enter the password to unlock each encrypted page. == Security level Security is never absolute. Data encrypted with these pages might be compromised in a variety of ways, including but not limited to the following: * User-generated passwords are weak by nature (PBKDF2 will be used in a future version) * You have not disabled the AES key cache, so when you enter the password for the first time other users (if not you) will be able to see encrypted pages and could possibly get your key * WoaS uses random numbers generated by the browser itself using local time; if someone was somehow able to gain access to the particular time used they could perhaps discover the key (user-generated entropy will be used in a future version) * Your Web browser and/or JavaScript interpreter may contain bugs or deliberate security violations which report activity on your computer back to some other Internet site * Some other applet running on another page in your browser, perhaps without you being aware of its existence, is spying on other windows. * Some other "spyware" application running on your computer may have compromised your system's security and be snooping on your activity. * The implementation of the encryption may contain a bug that makes its results insecure, Wiki on a Stick is open-source; you can judge for yourself whether the tool merits your confidence. * Your computer's security may have been compromised physically; when's the last time you checked that a bug that transmits your keystrokes and/or screen contents to that white van parked down the street wasn't lurking inside your computer cabinet? Apart from the above, your normal usage of encrypted pages can be considered secure. ', '
= Options
User Interface\
Syntax\ \
Saving\ \
WSIF settings\
Pages are stored internally if /WSIF data source/ is blank. *Existing internal pages will be deleted if /WSIF data source/ is changed from blank to an external source, and the external source will be overwritten with this wiki's content if it already exists!* If the /Use multiple files for WSIF data source/ option is being used (creating one WSIF file for each page) then disabling the option will not remove existing WSIF files, though the /WSIF data source/ index file will be overwritten with the full page content. The path may be entered in Windows or UNIX format. *Any directories in the path must exist if you are not using a Mozilla browser.*
  /Data source changes will not be used unless confirmed with the /Change data source /button./
Permanent changes\
  /Caution: to re-enable Help system you will need to import this file into a fresh Woas file./
  /Caution: to re-enable editing you will have to manually edit this WoaS file./\
', '[[Special::TOC]] A summary of WoaS deprecated syntax; you should not use deprecated syntax because it will be declared /unsupported/ in a future release of WoaS. The red examples demonstrate deprecated syntax and the green examples demonstrate syntax currently accepted by the wiki. == Headings Headings using exclamation marks are deprecated:
{{{ ! Heading level 1 !! Heading level 2 !!! Heading level 3 !!!! Heading level 4 !!!!! Heading level 5 !!!!!! Heading level 6 }}}
Headings using equal signs are accepted:
{{{ = Heading level 1 == Heading level 2 === Heading level 3 ==== Heading level 4 ===== Heading level 5 ====== Heading level 6 }}}
== Inline scripts Script tags that do not define a type are the default for HTML5, signifying JavaScript, and are accepted by WoaS. The current parser actually adds the /type/ attribute when creating scripts, and will ignore any other type specified. This also does not affect XHTML compatibility as they are obfuscated in the JavaScript storage, and added to pages generated by [[WoaS::Help::Special::Export|Special::Export]] HTML script tags without the *text/javascript* type attribute are best:
{{{ }}}
HTML script tags with the *text/javascript* type attribute are accepted:
{{{ }}}
== Lists Unordered lists using plus signs are not supported:
{{{ + unordered list item + unordered list item + unordered list item }}}
Unordered lists using asterisks are accepted:
{{{ * unordered list item * unordered list item * unordered list item }}}
== Macros The use of three angle brackets to mark a macro is now deprecated; two brackets are the Creole standard. The colon (:) after the macro name is also deprecated as unnecessary:
{{{ <<>>}}}
Use two brackets as per the Creole 1.0 spec, and drop the colon:
{{{ <> }}}
== Pre tags HTML {{{pre}}} tags surrounding raw or preformatted text are now treating like an ordinary {{{pre}}} tag. They will convert the text to the {{{pre}}} style, but any markup within them will still be parsed. For example: {{{
raw or */preformatted/* text
}}} is parsed as
raw or */preformatted/* text
({{{pre}}} is a /block/ tag, creating a separate line) but {{{{{{raw or */preformatted/* text}}}}}} is parsed as {{{raw or */preformatted/* text}}}, preserving the inline syntax used. {{{Pre}}} tags have their uses, but they are no longer treated as special markup by WoaS. == Rulers Horizontal rules using 3 hyphens are deprecated:
{{{ --- }}}
Horizontal rules using 4 or more hyphens are accepted:
{{{ ---- }}}
== Tags === Single tags Tags in the Tag:: and the Tags:: [[WoaS::Help::Namespaces|reserved namespace]] are accepted:
{{{ [[Tag::some tag]] [[Tags::some tag]] }}}
=== Multiple tags Tags separated by pipes in the Tag::, [[Tagged::]], or Tags:: namespace are deprecated:
{{{ [[Tag::some tag|other tag|another tag]] [[Tagged::some tag|other tag|another tag]] [[Tags::some tag|other tag|another tag]] }}}
Tags separated by commas in the Tag::, [[Tagged::]], and Tags:: namespace are accepted:
{{{[[Tag::some tag, other tag, another tag]] [[Tags::some tag, other tag, another tag]] [[Tagged::some tag, other tag, another tag]] }}}
', '[[Special::TOC]]/The [[Special::Options]] page currently stores all options within the WoaS HTML file when the/ Save options /button is clicked; they are never stored inside an external datasource [[WoaS::Help::WSIF|WSIF]] file. Currently the options will also be saved whenever a page is edited, though this will be changed in a future version./ ==User Interface ===Do not temporarily cache the AES key Clears the [[WoaS::Help::Security|AES key]] immediately after encrypting or decrypting a page to prevent possible unauthorized access. Using this option will require the key to be entered each time you want to read an encrypted page. ===Double-click to edit pages/menu Opens the editor when the main text area or menu are double-clicked. ===Enable debug mode Enables display of the debug console at the bottom of the main text area and allows the wiki to log its history. This can be useful if you asking are for help or reporting a problem. ===Start with console closed Ensures that the debug console will start closed. This option is disabled if /Enable debug mode/ is not selected. ===Fixed menu Fixes the menu in place while allowing the page to scroll. This option is disabled in IE6. ===Fixed navigation bar Fixes the navigation bar in place while allowing the page to scroll. This option is disabled in IE6. ===Sort tags in tag display Sorts the tags in the tag display alphabetically. ===Create a main menu link to newly created pages WoaS is able to put a link to newly created pages in the main menu. Whether or not it does so depends on the setting of this option. The link will not be created if the new page is cancelled. * /Always Ask/ prompts for a decision each time a new page is created * /Always/ creates a link without asking * /Never/ disables this function == Syntax ===Automatically convert URLs to hyperlinks converts URLs to [[WoaS::Help::Links|external links]] when the page content is displayed. ===Enhanced tables syntax Tables will use the enhanced [[WoaS::Help::Tables|table syntax]]. == Saving ===Automatically save options before quitting (if changed) Saves changes to options automatically when closing the wiki. This will not happen if you are just reloading the file. ===Enable safe mode with embedded scripts and plugins not executed (/requires reload/) Prevents the wiki from executing [[WoaS::Help::JavaScript|embedded scripts]] and [[WoaS::Help::Plugins|plugins]]. ===Make merge/diff of WoaS XHTML/WSIF data source easier Adds a [[WoaS::Help::Join lines of text|backslash]] and line-end character (\\n) to the end of every line of page text. This breaks the text into multiple lines, instead of it being one page-length line, making it easier for source code revision tools (like SVN or git) and merge tools to mark and show changes efficiently. ===Store and display last modified time-stamp Allows the wiki to store the last time each page was changed and display it as a time-stamp beneath the main text area. ===Store current page and navigation history Remembers the most recent back history and automatically opens the most recently saved page whenever you load the wiki into a browser. == WSIF settings WoaS is most often used as a single-file wiki, with all of it's content inside one self-modifying XHTML file, but it can also be used with external content files, called [[WoaS::Help::WSIF|WSIF]] files. It can use a single WSIF file containing all of the wiki's page content, or a single WSIF index file that links to the WSIF files of individual pages. Everything works the same whichever way it is used. If you just want to use a WSIF file for backing up or sharing your data with others you should use [[WoaS::Help::Special::ExportWSIF|Special::ExportWSIF]] instead as the WoaS file is then not altered. ===Relative path to WSIF data source, including filename This is the relative path and name of the file the wiki should use to save and retrieve data. A relative path is one that starts in the same directory the WoaS file is in; {{{temp/file.wsif}}} is a relative path, {{{/temp/file.wsif}}} is not; {{{c:\temp\file.wsif}}} and {{{c:temp\file.wsif}}} are also incorrect. The file name can have any extension or none at all, but the /wsif/ extension will let you know that it's a WoaS data source file. The path may be entered in Windows or UNIX format, but will be converted to the correct format upon entry (it is stored in the WoaS file in UNIX format). Providing a filename causes the wiki to create a WSIF file by that name and use that file to store and retrieve all page data (configuration options are currently always stored in the WoaS HTML file, not in a WSIF file). If just a filename is entered the file will be created inside the directory the WoaS file is in. The path can additionally specify a directory path relative to the location of the wiki. WoaS will create the specified subdirectory only if you are using a Gecko-based browser like Firefox. If you are using a different browser you must create the subdirectory yourself before saving the file. (As of this writing, the best browser to use with WoaS is *Firefox*; while [[WoaS::Help::Requirements & saving|all major browsers]] can be used to read, edit, and save a WoaS file, other browsers cannot currently import or export binary files, such as image files. This limits some capabilities, like embedding images or exporting them to a binary image file.) <<_note If you enter the name of an existing file that file will be overwritten when /Change data source/ is clicked; any associated files will also be overwritten if /multiple files/ mode is selected.>> The data source name will be used as the index page name when using multiple files as a data source. The box is blank by default. Leaving the box blank, or deleting an existing filename from the box, causes the wiki to save all the currently loaded data to itself and retrieve all data from itself. Deleting the filename from the box does not delete any files. ===Use multiple files in WSIF data source Causes the wiki to create individual WSIF files for each page. The pages will be automatically named by page number in their order of creation. An index page with the WSIF data source filename will be created containing a list of the numbered file names and their corresponding wiki page names. WoaS will use this file to load data and save edits to the correct file. <<_note The two WSIF data source settings described above will *not* be used or saved unless you confirm the change with the /Change data source/ button. WoaS will then describe the impact of the changes you are about to make so you can change your mind if you want to by pressing cancel.>> ===WSIF author This is the name of the author as displayed in exported WSIF files. Replace the default name with your own to be credited as the author of the file(s). Deleting the contents of the box prevents the author line from being added to WSIF files. ==Permanent changes ===Prevent edits Clicking this button puts the wiki into read-only mode. The edit icon is removed and all editing is disabled. To re-enable editing, the wiki must be [[WoaS::Help::Wiki is read-only|manually edited]]. If the file is already in read-only mode the /Prevent Edits/ button is not displayed. ', ' [[Javascript::woas._embed_process('%1', d$.file('filename_'))|Embed %1]]', '= Installed plugins
', '
= Export content into linked XHTML files
*Directory paths must exist if using a non-Mozilla browser. If exported files already exist they will be overwritten.*
Custom page scripts
Other options
\ ', '= Special::License This version of Woas, adapted by [[https://sourceforge.net/users/pvhl|PVHL]] is released under the GNU AGPL ('Affero') license, version 3 or later, to protect its freedom in a networked environment. This license is compatible with WoaS' older [[http://www.gnu.org/licenses/gpl2.txt|GNU GPL2 license]] in that AGPL can include GPL code within it; the reverse is not the case. Retrieved from [[http://www.gnu.org/licenses/agpl.txt]]: ', '
= Export to [[WoaS::Help::WSIF|WSIF]] format
File generation options
*Directory path must exist if using a non-Mozilla browser. If file exists it will be overwritten, along with any associated files if exporting to multiple files.* Filename is the name of the page index file if /Export as multiple WSIF files/ is selected.
Other options ', '[[Special::TOC]] *W*iki on a *S*tick *I*nterchange *F*ormat is the preferred format for exporting WoaS content to a single file. This allows you to share it with whomever you like, or to archive your content. This page describes version 1.4.0 of the format. \ = Format description \ <<_note The WSIF 1.4.0 version introduces some changes, mostly concerned with moving to a /convention over configuration/ pattern: * removes the ability to have external file content for embedded files ([[WoaS::Help::Images|Image::]] and [[WoaS::Help::Files|File::]] pages), as most browsers can't write binary files and the concept breaks the whole idea of the WSIF file as a sharing format; this has also led to the removal of some header names and may lead to further changes in the future (removal of the /mime/ page header); * adds the ability for WoaS to define page defaults in the WSIF information header, including a default /[[#Inline boundary|boundary]]/ value; * in partnership with the above change, removes the page headers that define a conventional page, {{{page.attributes:0}}} and {{{page.encoding:8bit/plain}}} (this doesn't prevent these defaults from being changed in some future format version); * removes the first boundary value as superfluous; the blank line after a header block serves as the first boundary for page content; the boundary search routine has also been improved so that a content/boundary conflict can now only occur if the exact boundary string, including dashes, occurs at the start of a content line; * removes {{{woas.}}} from in front of the {{{page.}}} namespace as unnecessary; WSIF is for WoaS-like Wikis and has /WoaS/ embedded in it's acronym; further branding is surely unnecessary and bloated. These changes haven't affected this Woas' ability to import older format versions. >> WSIF format is similar to MIME email attachments format; each line is formatted like an /email header/ definition: {{{ header.name: header-value }}} Header names must be alphanumeric only, plus the namespace 'dot' ({{{.}}}): they cannot include the underscore character, {{{_}}} (the code transforms header names internally for efficiency, leading to this limitation). The space after the colon and before the {{{header-value}}} is optional but present in all Woas generated files. All WSIF content must be ASCII, so {{{header-value}}} must be ECMA-escaped when necessary; this corresponds to escaping slashes (from {{{\}}} to {{{\\}}}) and encoding any UTF-8 sequence to the corresponding {{{\u0000}}} string, where {{{0000}}} is the lowercase hexadecimal value of the UTF-8 character (as in ECMAScript); this encoding uses the {{{woas.ecma_encode()}}} function in WoaS. A WSIF file contains header blocks that describe its contents. Header blocks contain one or more header lines, in any order, followed by a blank line ({{{\n\n}}}); the blank line is used to mark the end of both information and page header blocks. The /WSIF information/ header block (using the /wsif/ namespace) describes the file itself, and the /WoaS page/ header blocks (using the /page/ namespace) describe the pages contained within it. The file starts with the WSIF information header block, including any optional page header defaults (new in 1.4.0), and ends with a blank line. In a /conventional/ (inline content) WSIF file the information block is followed by one or more page definitions. There are two other WSIF file types (/[[#Index|index]]/ and /[[#Page|page]]/) that use a slightly different format. \ == Reserved namespaces === /wsif/ namespace \ The {{{wsif.}}} namespace defines an information header. The required headers are: * *wsif.version* - WSIF format version used by the file; * *wsif.generator* - program/library used to generate WSIF content; * *wsif.generator.version* - version of generator (usually WoaS) used to produce the WSIF file; this header is currently optional for imported content not generated by a WoaS file, though this is likely to change soon so that WoaS derivatives can also be imported properly. The optional headers are: * *wsif.author* - the name of the person generating the WSIF file; * *wsif.pages* - total count of pages stored inside the WSIF file; this is not used by Woas anymore, but can be handy when looking at the file. * *wsif.type* - only present for external data source use. *[[#Index|wsif.type: index]]* lets the system know the page is a special /Index/ listing of the content pages and their associated filenames. This type also allows for an optional page description. *[[#Page|wsif.type: page]]* is present when the /Use multiple files for WSIF data source/ option is selected within the /[[WoaS::Help::Special::Options#s9272|WSIF settings]]/ section of the [[Special::Options#s9272|Special::Options]] page. Version 1.1.0 and above are currently supported.
PVHL: My Woas will be adding optional /hash/ and /signed/ headers to the /wsif/ namespace in a future Woas and WSIF version, along with the ability to sign individual pages (or, more accurately, to sign their hash value). There will also be /date.created/, /date.modified/, and /description/ headers. Hopefully these changes will also be accepted by the WoaS project.
\ === /page/ namespace \ The {{{page.}}} namespace defines general WoaS content properties and specific WoaS pages. The 1.4.0 WSIF version introduces default content headers placed in the information header block and also conventional values (for /attributes/ and /encoding/) that don't need to be stated at all. The defaults are for a plain ASCII page that has not been encrypted, escaped, or encoded as base64 content: a normal WoaS page. If a page has the same header values as the default header or conventional values they need not be repeated. This means a conventional page need only have headers for its title and possibly its modification date (currently optional). The following are header definitions specific to WoaS pages: * *page.title* - ECMA-escaped page title; * *page.attributes* - a positive integer value in decimal format specifying the page attributes; attribute values are binary {{{OR}}}'d together to form a single decimal value, so an image file has an attribute value of {{{12}}} (embedded file and image), or {{{13}}} if it is read-only; the current attributes are: ** *0* - a conventional page, and so also the conventional value that need not be stated, ** *1* - read only, ** *2* - encrypted, ** *4* - embedded file (/[[WoaS::Help::Images|Image::]]/ and /[[WoaS::Help::File
Posted at 10:17 am by gosho

The iHelp