| Index: trunk/extensions/UploadWizard/js/jquery/plugins/jquery.arrowSteps.js |
| — | — | @@ -8,31 +8,39 @@ |
| 9 | 9 | * Derivative works and later versions of the code must be free software |
| 10 | 10 | * licensed under the same or a compatible license. |
| 11 | 11 | * |
| 12 | | - * Sometimes we want to show the user their progress through steps. One typical |
| 13 | | - * way to show this is with a row of text blocks connected by arrows, with the |
| 14 | | - * current step highlighted. |
| 15 | 12 | * |
| 16 | | - * Create a list in HTML -- ordered or unordered. It works better if it has a fixed width. |
| | 13 | + * DESCRIPTION |
| 17 | 14 | * |
| 18 | | - * <ul id="robin-hood-daffy" style="width:600px"> |
| 19 | | - * <li id="guard">Guard!</li> |
| 20 | | - * <li id="turn"/>Turn!</li> |
| 21 | | - * <li id="parry"/>Parry!</li> |
| 22 | | - * <li id="dodge"/>Dodge!</li> |
| 23 | | - * <li id="spin"/>Spin!</li> |
| 24 | | - * <li id="ha"/>Ha!</li> |
| 25 | | - * <li id="thrust"/>Thrust!</li> |
| 26 | | - * </ul> |
| | 15 | + * Show users their progress through a series of steps, via a row of items that fit |
| | 16 | + * together like arrows. One item can be highlighted at a time. |
| 27 | 17 | * |
| 28 | | - * Initialize: |
| 29 | 18 | * |
| | 19 | + * SYNOPSIS |
| | 20 | + * |
| | 21 | + * <ul id="robin-hood-daffy" style="width:600px"> |
| | 22 | + * <li id="guard">Guard!</li> |
| | 23 | + * <li id="turn"/>Turn!</li> |
| | 24 | + * <li id="parry"/>Parry!</li> |
| | 25 | + * <li id="dodge"/>Dodge!</li> |
| | 26 | + * <li id="spin"/>Spin!</li> |
| | 27 | + * <li id="ha"/>Ha!</li> |
| | 28 | + * <li id="thrust"/>Thrust!</li> |
| | 29 | + * </ul> |
| | 30 | + * |
| | 31 | + * <script language="javascript"><!-- |
| 30 | 32 | * $( '#robin-hood-daffy' ).arrowSteps(); |
| 31 | | - * |
| 32 | | - * And then use: |
| 33 | | - * |
| | 33 | + * |
| 34 | 34 | * $( '#robin-hood-daffy' ).arrowStepsHighlight( '#guard' ); |
| | 35 | + * // 'Guard!' is highlighted. |
| 35 | 36 | * |
| | 37 | + * // ... user completes the 'guard' step ... |
| | 38 | + * |
| | 39 | + * $( '#robin-hood-daffy' ).arrowStepsHighlight( '#turn' ); |
| | 40 | + * // 'Turn!' is highlighted. |
| 36 | 41 | * |
| | 42 | + * //--> |
| | 43 | + * </script> |
| | 44 | + * |
| 37 | 45 | */ |
| 38 | 46 | |
| 39 | 47 | ( function( $j ) { |