APL Wiki|
Size: 2156
Comment:
|
Size: 4487
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
<<SeeSaw(section="toc", show=True, toshow="(<<show>> Contents)", tohide="(<<hide>> Contents)")>> {{{#!wiki seesaw/toc/show <<TableOfContents>> }}} '''''SeeSaw''''' is a !MoinMoin macro written by Jim Wight. |
|
| Line 5: | Line 13: |
| In case that a particular topic is very complex, you might have to provide quite a large amount of information. On the Web, chances are that a use will stop reading any information at all if she gets flooded with to many pieces of information. | In case that a particular topic is very complex, you might have to provide quite a large amount of information. On the Web, chances are that a user will stop reading any information at all if she gets flooded with too many pieces of information. |
| Line 9: | Line 17: |
| That's what the MoinMoin macro SeeSaw is designed to do. | That's what the !MoinMoin macro SeeSaw is designed to do. |
| Line 11: | Line 19: |
| == Inline Usage == | == Applications == |
| Line 13: | Line 21: |
| <<SeeSaw(section=example1)>> example 1 {{{#!wiki seesaw/example1 This text was hidden initially and the link shown was "Show"; it should now be "Hide" |
There are three main applications for this purpose: * (Show (and later may be hide) a string of characters within a particular paragraph. * Switch between to different version of a paragraph, for example a "UNIX" and a "Windows" version. * Reveal a (potentially large amount of) text after a click on a kind of short description or header The first application works "Inline", the other two on a "Section". These three applications are demonstrated underneath. === Inline Usage === This line contains some <<SeeSaw(section=example1, inline=" hidden", bg="#FEE1A5")>> text. Click on the link to show it. === Section Usage === ==== Reveal Text ==== <<SeeSaw(section="example2a", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5")>> {{{#!wiki seesaw/example2a/example2-bg/hide This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. * Might contain all sorts of elements * Including lists |
| Line 18: | Line 54: |
| == Section Usage == | ==== Reveal Code ==== |
| Line 20: | Line 56: |
| <<SeeSaw(section=example2, toshow="Show the details")>> {{{#!wiki seesaw/example2/Show the details This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. This paragraph might contain a large amount of details only geeks might be interested in. |
Note that for including code, the SeeSaw code must be embraced not by three but by four curlies (={}). Only then APL code, which needs to be embraced by three curlies as well, will get recognized as such properly. <<SeeSaw(section="example2b", toshow="<<Show>> the code", tohide="<<Hide>> the code", bg="#FEE1A5")>> {{{{#!wiki seesaw/example2b/example2b/hide {{{ Prim←{{⍵/⍨2=+⌿0=⍵∘.|⍵}⍳⍵} }}} }}}} ==== Toggle Text ==== {{{#!wiki seesaw/example3/show '''Dyalog Section''' (show <<SeeSaw(section="example3", toshow="APLX")>> section) Some details related to Dyalog APL.<<BR>> This is shown initially. It is hidden and the "APLX" section is displayed when "Show APLX section" is clicked. |
| Line 25: | Line 75: |
| {{{#!wiki seesaw/example2/Hide Almost nothing |
{{{#!wiki seesaw/example3/hide '''APLX Section''' (Show <<SeeSaw(section="example3", toshow="Dyalog")>> section) Some details related to APLX.<<BR>> This is hidden initially. |
| Line 28: | Line 81: |
== Conclusion == To hide complex parts of information is possible in two ways: * Splitting it into different pages, adding links to sub-pages * Represent the details by a short description and make it visible by a click on it without the additional drawback of a page reload. The former technique has it's merits, of course, but it comes with drawbacks as well: If the sub-pieces are relatively small but their total number is high, it might increase the number of pages dramatically. Not helpful at all when searching pages. In those cases the hide/show technique represented here is certainly an alternative. The "Reveal" method would be appropriate for that. However, the other methods demonstrated on this page are less usefull, but still... Only it needs !JavaScript: if the user has disabled it, the whole damn mechanism doesn't work. |
SeeSaw Macro
Contents
SeeSaw is a MoinMoin macro written by Jim Wight.
Overview
In case that a particular topic is very complex, you might have to provide quite a large amount of information. On the Web, chances are that a user will stop reading any information at all if she gets flooded with too many pieces of information.
A common technique to deal with this problem is to provide only essential information but to allow the user to "show" more information usually represented by a short description.
That's what the MoinMoin macro SeeSaw is designed to do.
Applications
There are three main applications for this purpose:
- (Show (and later may be hide) a string of characters within a particular paragraph.
- Switch between to different version of a paragraph, for example a "UNIX" and a "Windows" version.
- Reveal a (potentially large amount of) text after a click on a kind of short description or header
The first application works "Inline", the other two on a "Section".
These three applications are demonstrated underneath.
Inline Usage
This line contains some »» text. Click on the link to show it.
Section Usage
Reveal Text
Show the details
Reveal Code
Note that for including code, the SeeSaw code must be embraced not by three but by four curlies (={}). Only then APL code, which needs to be embraced by three curlies as well, will get recognized as such properly.
Show the code
Toggle Text
Dyalog Section (show APLX section)
Some details related to Dyalog APL.
This is shown initially. It is hidden and the "APLX" section is displayed when "Show APLX section" is clicked.
Conclusion
To hide complex parts of information is possible in two ways:
- Splitting it into different pages, adding links to sub-pages
- Represent the details by a short description and make it visible by a click on it without the additional drawback of a page reload.
The former technique has it's merits, of course, but it comes with drawbacks as well: If the sub-pieces are relatively small but their total number is high, it might increase the number of pages dramatically. Not helpful at all when searching pages.
In those cases the hide/show technique represented here is certainly an alternative. The "Reveal" method would be appropriate for that.
However, the other methods demonstrated on this page are less usefull, but still...
Only it needs JavaScript: if the user has disabled it, the whole damn mechanism doesn't work.