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

Last change on this file since 195 was 192, checked in by mbutscher, 10 years ago

branches/mbutscher/work:
2.0beta03

  • Option to reverse search order for scripts (global imports first)
  • Wiki-bound option to create wiki page files with ASCII-only names (does not apply to Compact Sqlite DB backend). This should also fix a problem with Windows binary installer and WikidPad help wiki on non-western Windows versions.
  • Wiki-bound option to handle missing or externally inserted page files gracefully (does not apply to Compact Sqlite DB backend)
  • New insertion "iconimage" to insert an icon into an HTML page.
  • Preview shows link target in the status bar when hovering with mouse over it like browsers do
  • Menu item "Select All" in "Edit" menu (for completeness)
  • Bug fixed: Some errors weren't recorded in error log
  • Bug fixed: stdDialog of doc page presenter did not return a value (needed for some plugins)
  • Bug fixed: Tree scrolled to wrong initial position on startup
  • Bug fixed: Windows: Spell check addon did not work due to wrong DLL find mechanism
  • Bug fixed: LossyWikiCloseDeniedException? wasn't caught and polluted error log
  • Bug fixed: Search and replace dialog for page cleared "Search" text field when "Find next" was pressed
  • Bug fixed: Wiki-wide search dialog did not focus search text field when initially shown
  • Bug fixed: Pollution of error log if moving mouse over incremental search field
File size: 3.9 KB
Line 
1++ Insertions
2
3Insertions allow to insert some dynamic text into preview and HTML export of a page. This text can either be the content of another page or a list of wikipage links to pages which are parents or children of a page or to pages which form the result of a saved search.
4
5To insert, for example, the content of the IncrementalSearch page, write:
6
7[:page: IncrementalSearch]
8
9----
10
11If you switch now to the preview, you will see the content of the IncrementalSearch page above, instead of the insertion tag.
12
13
14+++ Syntax
15The tag begins always with '[:' then comes the _insertion key_, then a colon and the _insertion value_,
16after that there may be appendices, separated by semicolons, to describe the way of presentation in more detail. The tag is closed by a closing bracket.
17
18In the example above, "page" is the insertion key, "IncrementalSearch" is the value.
19
20The value and appendices can be quoted (enclosed by quotation symbols) if they shall contain special characters or newlines. A quotation symbol is an arbitrary number of one of the quotation characters ", ', / or \ (double quotation mark, single quotation mark, slash or backslash). The starting and ending symbols must be the same. Examples for quotation symbols are:
21
22"
23'''
24//
25/////
26\\
27
28The above insertion example can therefore be written as:
29
30<<
31[:page: "IncrementalSearch"]
32[:page: '''IncrementalSearch''']
33[:page: //IncrementalSearch//]
34[:page: /////IncrementalSearch/////]
35[:page: \\IncrementalSearch\\]
36>>
37
38The following keys and values are built into WikidPad (further are possible by plugins):
39
40    * *page* shows the content of the existing wiki page which is
41      given as insertion value.
42    * *rel* lists all wiki words related to this page in the way
43      described by the value:
44        * *parents*: all parents of the page
45        * *children*: all children (= all wiki links) of the page.
46          With appendix "existingonly" only the really existing
47          pages are listed
48        * *parentless*: all parentless pages. The list is
49          independent from the page containing the insertion tag.
50        * *undefined*: all undefined wiki word links. The list is
51          independent from the page containing the insertion tag.
52        * *back*: go back in history of WikidPad tab (or browser
53          on export)
54    * *savedsearch* lists all wiki words found by the saved search
55      with the name given as value.
56    * *toc* shows a little table of contents with the headings of
57      the current page. In HTML preview/export you can click on the
58      the lines to go to the actual headings. The value of this
59      insertion must be empty.
60    * *iconimage* shows the icon whose name is given as value.
61      You can use menu "Format"->"Icon Name" to find the name of
62      an existing icon.
63    * *eval* Evaluate the given Python expression and handle its
64      result as if it replaces the insertion. You must switch on
65      the appropriate option "Process insertion scripts" on the
66      "Security" options page to make it work.
67    * *self* Shows the name of the current page.
68
69
70For insertion tags which produce lists of wiki links (all but the "page" and "eval" insertion), you can also have the appendix "columns 123" where 123 stands for the number of columns the list should have. By default, there is only one column.
71
72+++ Examples
73
74At first a few wiki links to demonstrate the functions: (KeyBindings, DeadLink, DeadLinkToo, ScratchPad, TextBlocks)
75
76It is recommended to switch to preview to see the effect of the tags:
77
78*\[:rel: parents]*
79[:rel: parents]
80
81*\[:rel: children]*
82[:rel: children]
83
84*\[:rel: children;existingonly;columns 2]*
85[:rel: children;existingonly;columns 2]
86
87*\[:savedsearch: nanny; columns 4]*  (all pages containing "any")
88[:savedsearch: nanny; columns 4]
89
90*\[:toc:]*
91[:toc:]
92
93*\[:eval:"5+6"]*
94[:eval:"5+6"]
Note: See TracBrowser for help on using the repository browser.