Differences between revisions 38 and 40 (spanning 2 versions)
⇤ ← Revision 38 as of 2009-01-01 09:30:35 →
Size: 5221
Editor: KaiJaeger
Comment:
← Revision 40 as of 2009-06-30 11:25:46 → ⇥
Size: 5357
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
<<SeeSaw(section="toc", toshow="<<Show>> table of contents", tohide="<<Hide>> table of contents", bg="#FEE1A5", speed="Slow")>>
{{{#!wiki seesaw/toc/toc-bg/hide
Line 4: Line 6:
}}}
Line 8: Line 11:
Line 16: Line 18:
Line 30: Line 31:
Line 34: Line 34:
Line 36: Line 35:
Line 47: Line 45:
Line 49: Line 46:
Line 51: Line 47:
Line 61: Line 56:
Line 63: Line 57:
Line 70: Line 63:
Line 77: Line 69:
Line 79: Line 70:
Line 81: Line 71:

Sometimes, so rarely, !MoinMoin refuses to deliver all pictures, if there are many of them on a page. Although this sound unlikely, this effect happens to happen more often in a !SeeSaw-controlled sections. This is not a mistake of !SeeSaw - pressing F5 often fixes the problem, or at least changes the problem: invisible pictures might become visible while visible pictures might become invisible.		 Sometimes, so rarely, !MoinMoin refuses to deliver all pictures, if there are many of them on a page. Although this sounds unlikely, this effect happens to happen more often in !SeeSaw-controlled sections. This is not a mistake of !SeeSaw - pressing F5 often fixes the problem, or at least changes the problem: invisible pictures might become visible while visible pictures might become invisible.
Line 87: Line 76:
Line 91: Line 79:
Line 95: Line 82:
 

SeeSaw Macro

Show table of contents

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

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

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 

Prim←{{⍵/⍨2=+⌿0=⍵∘.|⍵}⍳⍵}

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.

APLX Section (Show Dyalog section)

Some details related to APLX.
This is hidden initially.

Warnings

Pictures

Sometimes, so rarely, MoinMoin refuses to deliver all pictures, if there are many of them on a page. Although this sounds unlikely, this effect happens to happen more often in SeeSaw-controlled sections. This is not a mistake of SeeSaw - pressing F5 often fixes the problem, or at least changes the problem: invisible pictures might become visible while visible pictures might become invisible.

So try to avoid putting a section with many pictures into a SeeSaw-controlled section. This is a very rare problem which you might never come across anyway.

Table-of-contents

In version 1.7.1 of MoinMoin (where SeeSaw was made available), a TOC could very well be controlled by SeeSaw. This feature stopped working after upgrading to MoinMoin 1.8.1

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 (last edited 2017-02-16 18:42:06 by KaiJaeger)