1398
Comment:
|
4107
|
Deletions are marked like this. | Additions are marked like this. |
Line 3: | Line 3: |
'''SeeSaw''' is a !MoinMoin macro written by Jim Wight. | '''''Note that this stuff is currently experimental''''' <<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 13: | Line 22: |
== Inline Usage == | == 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 === |
Line 17: | Line 40: |
== Section Usage == | === Section Usage === |
Line 19: | Line 42: |
=== I. Reveale text === | ==== Reveal Text ==== |
Line 21: | Line 44: |
<<SeeSaw(section="example2", toshow="Show the details", tohide="Hide the details", bg="#FFFFDD")>> | <<SeeSaw(section="example2", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FEE1A5")>> |
Line 23: | Line 46: |
{{{#!wiki seesaw/example2/show 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. |
{{{#!wiki seesaw/example2/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 * But '''not''' APL code I am afraid! |
Line 27: | Line 58: |
=== II. Toggle text === | ==== Toggle Text ==== |
Line 29: | Line 60: |
<<SeeSaw(section="example2", toshow="Dyalog section", tohide="APLX section")>> | {{{#!wiki seesaw/example3/show '''Dyalog Section''' (show <<SeeSaw(section="example3", toshow="APLX")>> section) |
Line 31: | Line 63: |
{{{#!wiki seesaw/example2 Some details; related to Dyalog APL |
|
Line 34: | Line 64: |
{{{#!wiki seesaw/example2/example2-bg Some details; related to APLX |
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 38: | Line 69: |
'''Not working yet - still under construction!''' | {{{#!wiki seesaw/example3/hide '''APLX Section''' (Show <<SeeSaw(section="example3", toshow="Dyalog")>> section) Some details related to APLX.<<BR>> This is hidden initially. }}} == 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. The other techniques, however, are less usefull, but still... Only it needs !JavaScript: if the user has disabled it, the whole damn mechanism doesn't work. |
SeeSaw Macro
Note that this stuff is currently experimental
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
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.
The other techniques, however, are less usefull, but still...
Only it needs JavaScript: if the user has disabled it, the whole damn mechanism doesn't work.