Differences between revisions 1 and 24 (spanning 23 versions)

SeeSaw Macro

( ( show hide Contents) 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 »» «« hidden text. Click on the link to show it.

Section Usage

Reveal Text

Show Hide the details the details

Toggle Text

Dyalog Section (show APLX 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.

Some filling text.

-  ⇤ ← Revision 1 as of 2008-12-11 17:27:46 → 
  Size: 2156
  Editor: KaiJaeger
  Comment:
+   ← Revision 24 as of 2008-12-13 10:44:34 → ⇥
  Size: 3215
  Editor: KaiJaeger
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 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 16:
-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 20:
-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 22:
-== Inline Usage ==
+== Applications ==
-Line 13:
+Line 24:
-<<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")>> text. Click on the link to show it.

=== Section Usage ===

==== Reveal Text ====

<<SeeSaw(section="example2", toshow="<<Show>> the details", tohide="<<Hide>> the details", bg="#FFFFDD")>>

{{{#!wiki seesaw/example2/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 18:
+Line 58:
-== Section Usage ==
+==== Toggle Text ====
-Line 20:
+Line 60:
-<<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.
+{{{#!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 69:
-{{{#!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 77:
+Some filling text.