WordPress.org
Get WordPress

Plugin Directory

Changeset 995986


Ignore:
Timestamp:
09/24/2014 10:38:49 AM (12 years ago)
Author:
Clear_Code
Message:

Documentation Upgrade

Location:
cngann-shortcodes
Files:
1 deleted
1 edited
19 copied

Legend:

Unmodified
Added
Removed

  • cngann-shortcodes/tags/4.0/readme.txt

    r981064 r995986  
    1414Shortcodes used by ClearCode in their WordPress sites.
    1515
    16 = Examples =
     16= How to read this guide =
     17
     18*There are so many different shortcodes in this plugin that it's impractical to list out all of the seperate use-cases that are available*
     19*The following shortcode declaration is an annotated guide describing how to read this documentation*
     20
     21**Shortcode: `[SHORTCODE_NAME]`** *This is the base shortcode that is being described*
     22
     23*Parameters -- A list of the different parameters (eg: `[SHORTCODE_NAME PARAMETER1="VALUE" BOOLEAN1="Y"]`)*
     24* PARAMETER1: The VALUE to assign to this parameter
     25 * Default: The default value that is assigned to this parameter, for example: "This is a test"
     26* BOOLEAN1: Set to "Y" if something is true, otherwise leave blank
     27
     28*Aliases -- If this shortcode can also be called as `[ALIAS1]` or `[ALIAS2]` it will be noted here*
     29* ALIAS1
     30* ALIAS2
     31
     32
     33Description of the shortcode and a general description of what it does.  If it has to be nested within another shortcode, that too will be documented in this area, like this. **Required Parent: `[SHORTCODE_PARENT_NAME]`**
     34
     35= Short Codes =
     36
     37**Shortcode: `[splits]`**
     38
     39*Parameters*
     40* None
     41
     42container for a row of splits
     43
     44**Shortcode: `[one_half]`**
     45
     46*Parameters*
     47
     48* first: Set to "Y" if it is the first one in the set
     49* last: Set to "Y" if it is the first one in the set
     50
     51Creates an element that is one-half of it's container's width. **Required Parent: `[splits]`**
     52
     53**Shortcode: `[one_third]`**
     54
     55*Parameters*
     56
     57* first: Set to "Y" if it is the first one in the set
     58* last: Set to "Y" if it is the first one in the set
     59
     60Creates an element that is one third of it's container's width. **Required Parent: `[splits]`**
     61
     62**Shortcode: `[two_thirds]`**
     63
     64*Parameters*
     65
     66* first: Set to "Y" if it is the first one in the set
     67* last: Set to "Y" if it is the first one in the set
     68
     69Creates an element that is two thirds of it's container's width. **Required Parent: `[splits]`**
     70
     71**Shortcode: `[one_fourth]`**
     72
     73*Parameters*
     74
     75* first: Set to "Y" if it is the first one in the set
     76* last: Set to "Y" if it is the first one in the set
     77
     78Creates an element that is one fourth of it's container's width. **Required Parent: `[splits]`**
     79
     80**Shortcode: `[two_fourths]`**
     81
     82*Parameters*
     83
     84* first: Set to "Y" if it is the first one in the set
     85* last: Set to "Y" if it is the first one in the set
     86
     87Creates an element that is two fourths of it's container's width. **Required Parent: `[splits]`**
     88
     89**Shortcode: `[three_fourths]`**
     90
     91*Parameters*
     92
     93* first: Set to "Y" if it is the first one in the set
     94* last: Set to "Y" if it is the first one in the set
     95
     96Creates an element that is three fourths of it's container's width. **Required Parent: `[splits]`**
     97
     98**Shortcode: `[one_fifth]`**
     99
     100*Parameters*
     101
     102* first: Set to "Y" if it is the first one in the set
     103* last: Set to "Y" if it is the first one in the set
     104
     105Creates an element that is one fifth of it's container's width. **Required Parent: `[splits]`**
     106
     107**Shortcode: `[two_fifths]`**
     108
     109*Parameters*
     110
     111* first: Set to "Y" if it is the first one in the set
     112* last: Set to "Y" if it is the first one in the set
     113
     114Creates an element that is two fifths of it's container's width. **Required Parent: `[splits]`**
     115
     116**Shortcode: `[three_fifths]`**
     117
     118*Parameters*
     119
     120* first: Set to "Y" if it is the first one in the set
     121* last: Set to "Y" if it is the first one in the set
     122
     123Creates an element that is three fifths of it's container's width. **Required Parent: `[splits]`**
     124
     125**Shortcode: `[four_fifths]`**
     126
     127*Parameters*
     128
     129* first: Set to "Y" if it is the first one in the set
     130* last: Set to "Y" if it is the first one in the set
     131
     132Creates an element that is four fifths of it's container's width. **Required Parent: `[splits]`**
     133
     134**Shortcode: `[clear]`**
     135
     136*Parameters*
     137
     138* none
     139
     140Creates an element that does clear:both
     141
     142**Shortcode: `[more]`**
     143
     144*Parameters*
     145
     146* title: the text to display when content is hidden
     147 * Default: Learn More... / Spoilers...
     148
     149*Aliases*
     150* Spoiler
     151* Spoil
     152
     153Creates a link that shows a hidden area of content when clicked
     154
     155**Shortcode: `[tabs]`**
     156
     157*Parameters*
     158
     159* class: CSS class(es) to assign to the outer element
     160
     161Creates a tabbed area.
     162
     163**Shortcode: `tab`**
     164
     165*Parameters*
     166
     167* title: the tab's title
     168 * Default: New Tab
     169
     170Creates a tab  **Required Parent: `[tabs]`**
     171
     172**Shortcode: `[slider]`**
     173
     174*Parameters*
     175
     176* height: Height in css-compatible units.
     177 * Example: 400px
     178
     179Creates a slider container
     180
     181**Shortcode: `[slide]`**
     182
     183*Parameters*
     184
     185* none
     186* src: Background image.  Can be either url or media ID.
     187* href|slug|id|link : Where to go when the slide is clicked.  Can be a url, slug, post/page ID, or any other link format.
     188
     189Makes a slide.  **Required Parent: `[slider]`**
     190
     191**Shortcode: `[hover]`**
     192
     193*Parameters*
     194
     195* class: CSS class(es) to assign to the element
     196
     197Creates an area that toggles between two different content ares on hover
     198
     199**Shortcode: `[on]`**
     200
     201*Parameters*
     202
     203* none
     204
     205designates the content displayed when there is no hover.  **Required Parent: `[hover]`**
     206
     207**Shortcode: `[off]`**
     208
     209*Parameters*
     210
     211* none
     212
     213designates the content displayed when there is hover.  **Required Parent: `[hover]`**
     214
     215**Shortcode: `[background]`**
     216
     217*Parameters*
     218
     219* bgcolor: the background color
     220* src: Background image.  Can be either url or media ID.
     221* position: Background Position.
     222 * Default: top left
     223* repeat: Background Repeat.
     224 * Default: no-repeat
     225* height: Height in css-compatible units.
     226 * Example: 400px
     227* width: width in css-compatible units.
     228 * Example: 100%
     229 * Default: 100%
     230* class: CSS class(es) to assign to the element
     231* color: the foreground color
     232* padding: padding of element
     233 * Default: "0px 0px 0px 0px"
     234
     235creates a div with a background you set
     236
     237**Shortcode: `[flashcard]`**
     238
     239*Parameters*
     240
     241* height: Height in css-compatible units.
     242 * Example: 400px
     243* width: width in css-compatible units.
     244 * Example: 100%
     245 * Default: 100%
     246* class: CSS class(es) to assign to the element
     247
     248click to rotate from `[front]` to `[back]`
     249
     250**Shortcode: `[front]`**
     251
     252*Parameters*
     253
     254* click : what to click to toggle the flip
     255 * Default: all
     256 * Example: .close
     257
     258Front side of the FlashCard  **Required Parent: `[flashcard]`**
     259
     260**Shortcode: `[back]`**
     261
     262*Parameters*
     263
     264* click : what to click to toggle the flip
     265 * Default: all
     266 * Example: .close
     267
     268Back side of the FlashCard  **Required Parent: `[flashcard]`**
     269
     270**Shortcode: `[linkmap]`**
     271
     272*Parameters*
     273
     274* height: Height in css-compatible units.
     275 * Example: 400px
     276* width: width in css-compatible units.
     277 * Example: 100%
     278 * Default: 100%
     279* class: CSS class(es) to assign to the element
     280* src: Background image.  Can be either url or media ID.
     281* hover_src: Alternate Background image.  Can be either url or media ID.
     282* flashcard: Set to "y" to make clicking an area flip to the content of that area
     283* bgcolor: The background color
     284 * Default: transparent
     285
     286Image map replacement using divs.
     287Use one image for the background, then alter that image for all of the hover changes.
     288Create a `[maplink]` for each clickable area in the image.
     289
     290A clickable area in a linkmap  **Required Parent: `[linkmap]`**
     291
     292**Shortcode: `[link]`**
     293
     294*Parameters*
     295
     296* class: CSS class(es) to assign to the element
     297* href|slug|id|link : Where to go when the slide is clicked.  Can be a url, slug, post/page ID, or any other link format.
     298
     299Get a link
     300
     301**Shortcode: `[title]`**
     302
     303*Parameters*
     304
     305* id|slug : an identifier for the post/page/etc... to get the title for
     306
     307Get the title for a page/post/etc... in your WordPress install
     308
     309**Shortcode: `[buttons]`**
     310
     311*Parameters*
     312
     313* align: the alignment of the inner of the area
     314
     315Designate a area that holds buttons
     316
     317**Shortcode: `[button]`**
     318
     319*Parameters*
     320
     321* class: CSS class(es) to assign to the element
     322* title: the text displayed in the button
     323
     324Create a div that's a button so jQuery can be used on it
     325
     326= Full Examples =
    17327
    18328**Splits**
    … …  
    35345[/tabs]`
    36346
    37 = Short Codes =
    38 
    39 **Shortcode: `[splits]`**
    40 
    41 *Parameters*
    42 * None
    43 
    44 container for a row of splits
    45 
    46 **Shortcode: `[one_half]`**
    47 
    48 *Parameters*
    49 
    50 * first: Set to "Y" if it is the first one in the set
    51 * last: Set to "Y" if it is the first one in the set
    52 
    53 Creates an element that is one-half of it's container's width
    54 
    55 **Shortcode: `[one_third]`**
    56 
    57 *Parameters*
    58 
    59 * first: Set to "Y" if it is the first one in the set
    60 * last: Set to "Y" if it is the first one in the set
    61 
    62 Creates an element that is one third of it's container's width
    63 
    64 **Shortcode: `[two_thirds]`**
    65 
    66 *Parameters*
    67 
    68 * first: Set to "Y" if it is the first one in the set
    69 * last: Set to "Y" if it is the first one in the set
    70 
    71 Creates an element that is two thirds of it's container's width
    72 
    73 **Shortcode: `[one_fourth]`**
    74 
    75 *Parameters*
    76 
    77 * first: Set to "Y" if it is the first one in the set
    78 * last: Set to "Y" if it is the first one in the set
    79 
    80 Creates an element that is one fourth of it's container's width
    81 
    82 **Shortcode: `[two_fourths]`**
    83 
    84 *Parameters*
    85 
    86 * first: Set to "Y" if it is the first one in the set
    87 * last: Set to "Y" if it is the first one in the set
    88 
    89 Creates an element that is two fourths of it's container's width
    90 
    91 **Shortcode: `[three_fourths]`**
    92 
    93 *Parameters*
    94 
    95 * first: Set to "Y" if it is the first one in the set
    96 * last: Set to "Y" if it is the first one in the set
    97 
    98 Creates an element that is three fourths of it's container's width
    99 
    100 **Shortcode: `[clear]`**
    101 
    102 *Parameters*
    103 
    104 * none
    105 
    106 Creates an element that does clear:both
    107 
    108 **Shortcode: `[more]`**
    109 
    110 *Parameters*
    111 
    112 * title: the text to display when content is hidden
    113  * Default: Learn More... / Spoilers...
    114 
    115 *Aliases*
    116 * Spoiler
    117 * Spoil
    118 
    119 Creates a link that shows a hidden area of content when clicked
    120 
    121 **Shortcode: `[tabs]`**
    122 
    123 *Parameters*
    124 
    125 * class: CSS class(es) to assign to the outer element
    126 
    127 Creates a tabbed area, `[tab]` designates it's children
    128 
    129 **Shortcode: `tab`**
    130 
    131 *Parameters*
    132 
    133 * title: the tab's title
    134  * Default: New Tab
    135 
    136 Creates a tab, to be used inside of `[tabs]`
    137 
    138 **Shortcode: `[slider]`**
    139 
    140 *Parameters*
    141 
    142 * height: Height in css-compatable units.
    143  * Example: 400px
    144 
    145 Creates a slider area, `[slide]` designates it's children
    146 
    147 **Shortcode: `[slide]`**
    148 
    149 *Parameters*
    150 
    151 * none
    152 * src: Background image.  Can be either url or media ID.
    153 * href|slug|id|link : Where to go when the slide is clicked.  Can be a url, slug, post/page ID, or any other link format.
    154 
    155 Makes a slide to be used inside of `[slider]`
    156 
    157 **Shortcode: `[hover]`**
    158 
    159 *Parameters*
    160 
    161 * class: CSS class(es) to assign to the element
    162 
    163 Creates an area that togges between two different content ares on hover
    164 
    165 **Shortcode: `[on]`**
    166 
    167 *Parameters*
    168 
    169 * none
    170 
    171 designates the area displayed before hover inside of `[hover]`
    172 
    173 **Shortcode: `[off]`**
    174 
    175 *Parameters*
    176 
    177 * none
    178 
    179 designates the area displayed with hover inside of `[hover]`
    180 
    181 
    182 
    183 **Shortcode: `[background]`**
    184 
    185 *Parameters*
    186 
    187 * bgcolor: the background color
    188 * src: Background image.  Can be either url or media ID.
    189 * position: Background Position.
    190  * Default: top left
    191 * repeat: Background Repeat.
    192  * Default: no-repeat
    193 * height: Height in css-compatable units.
    194  * Example: 400px
    195 * width: width in css-compatable units.
    196  * Example: 100%
    197  * Default: 100%
    198 * class: CSS class(es) to assign to the element
    199 * color: the foreground color
    200 * padding: padding of element
    201  * Default: "0px 0px 0px 0px"
    202 
    203 creates a div with a background you set
    204 
    205 **Shortcode: `[flashcard]`**
    206 
    207 *Parameters*
    208 
    209 * height: Height in css-compatable units.
    210  * Example: 400px
    211 * width: width in css-compatable units.
    212  * Example: 100%
    213  * Default: 100%
    214 * class: CSS class(es) to assign to the element
    215 
    216 click to rotate from `[front]` to `[back]`
    217 
    218 **Shortcode: `[front]`**
    219 
    220 *Parameters*
    221 
    222 * click : what to click to toggle the flip
    223  * Default: all
    224  * Example: .close
    225 
    226 Front side of the FlashCard
    227 
    228 **Shortcode: `[back]`**
    229 
    230 *Parameters*
    231 
    232 * click : what to click to toggle the flip
    233  * Default: all
    234  * Example: .close
    235 
    236 Back side of the FlashCard
    237 
    238 **Shortcode: `[linkmap]`**
    239 
    240 *Parameters*
    241 
    242 * height: Height in css-compatable units.
    243  * Example: 400px
    244 * width: width in css-compatable units.
    245  * Example: 100%
    246  * Default: 100%
    247 * class: CSS class(es) to assign to the element
    248 * src: Background image.  Can be either url or media ID.
    249 * hover_src: Alternate Background image.  Can be either url or media ID.
    250 * flashcard: Set to "y" to make clicking an area flip to the content of that area
    251 * bgcolor: The background color
    252  * Default: transparent
    253 
    254 Image map replacement using divs.
    255 Use one image for the background, then alter that image for all of the hover changes.
    256 Create a `[maplink]` for each clickable area in the image.
    257 
    258 A clickable area in a linkmap
    259 
    260 **Shortcode: `[link]`**
    261 
    262 *Parameters*
    263 
    264 * class: CSS class(es) to assign to the element
    265 * href|slug|id|link : Where to go when the slide is clicked.  Can be a url, slug, post/page ID, or any other link format.
    266 
    267 Get a link
    268 
    269 **Shortcode: `[title]`**
    270 
    271 *Parameters*
    272 
    273 * id|slug : an identifier for the post/page/etc... to get the title for
    274 
    275 Get the title for a page/post/etc... in your wordpress install
    276 
    277 **Shortcode: `[buttons]`**
    278 
    279 *Parameters*
    280 
    281 * align: the alignment of the inner of the area
    282 
    283 Designate a area that holds buttons
    284 
    285 **Shortcode: `[button]`**
    286 
    287 *Parameters*
    288 
    289 * class: CSS class(es) to assign to the element
    290 * title: the text displayed in the button
    291 
    292 Create a div that's a button so jquery can be used on it
     347**Link & Title**
     348`This will contain a link to the page whose id is 5 and it's title: [link id="5"][title id="5"][/link]`
    293349
    294350= Future Plans =
    … …  
    296352* Code Comments
    297353* Examples / How to
    298 * TinyMCE Integration - waiting for WP 3.9 (TinyMCE v4)
     354* Document advanced shortcodes better, get screenshots/video of them in action:
     355 * Linkmap
     356 * FlashCard
     357 * Slider
     358* TinyMCE Integration
    299359 * Buttons to create/edit shortcodes
    300  * Content filters that display shortcodes output in the editor and when focused on allow you to click the aformentioned button again to edit it's info - like bold or italic
     360 * Content filters that display shortcodes output in the editor and when focused on allow you to click the aforementioned button again to edit it's info - like bold or italic
    301361
    302362= Known Issues =
    303363
    304 * `[email_form]` needs to be tied into wordpress' email system and should actually send out an email
    305 * `[person]` needs formatting like I need therapy
     364* `[email_form]` needs to be tied into WordPress' email system and should actually send out an email
     365* `[person]` needs formatting
    306366
    307367== Screenshots ==
    … …  
    318378
    319379== Changelog ==
     380= 4.0 =
     381Added better documentation
     382Added a "How to read" section to the documentation.
     383Better format for documenting the required parent shortcode for shortcodes that require them.
     384Spell checked the Documentation.
     385
    320386= 3.8.07 =
    321387Added fifth splits
    … …  
    336402 * Slider "first" property - make it work in other themes
    337403 * Slider now uses src parameter instead of altering it's content to get an image
    338 * Removing Dependancy on php 5.3
     404* Removing Dependency on php 5.3
    339405* Removing development error reporting
    340406* Making Class Based
    … …  
    348414= 2.2 =
    349415* Cleanup
    350 * Added various parameter alias's
     416* Added various parameter aliases
    351417* Added link
    352418* Added title
    … …  
    362428
    363429= 3.3 =
    364 Bugfix for the severe error that was happening in 3.0 - 3.2
     430Bug-fix for the severe error that was happening in 3.0 - 3.2
    365431You'll want the background shortcode... trust me

  • cngann-shortcodes/trunk/readme.txt

    r981064 r995986  
    1414Shortcodes used by ClearCode in their WordPress sites.
    1515
    16 = Examples =
     16= How to read this guide =
     17
     18*There are so many different shortcodes in this plugin that it's impractical to list out all of the seperate use-cases that are available*
     19*The following shortcode declaration is an annotated guide describing how to read this documentation*
     20
     21**Shortcode: `[SHORTCODE_NAME]`** *This is the base shortcode that is being described*
     22
     23*Parameters -- A list of the different parameters (eg: `[SHORTCODE_NAME PARAMETER1="VALUE" BOOLEAN1="Y"]`)*
     24* PARAMETER1: The VALUE to assign to this parameter
     25 * Default: The default value that is assigned to this parameter, for example: "This is a test"
     26* BOOLEAN1: Set to "Y" if something is true, otherwise leave blank
     27
     28*Aliases -- If this shortcode can also be called as `[ALIAS1]` or `[ALIAS2]` it will be noted here*
     29* ALIAS1
     30* ALIAS2
     31
     32
     33Description of the shortcode and a general description of what it does.  If it has to be nested within another shortcode, that too will be documented in this area, like this. **Required Parent: `[SHORTCODE_PARENT_NAME]`**
     34
     35= Short Codes =
     36
     37**Shortcode: `[splits]`**
     38
     39*Parameters*
     40* None
     41
     42container for a row of splits
     43
     44**Shortcode: `[one_half]`**
     45
     46*Parameters*
     47
     48* first: Set to "Y" if it is the first one in the set
     49* last: Set to "Y" if it is the first one in the set
     50
     51Creates an element that is one-half of it's container's width. **Required Parent: `[splits]`**
     52
     53**Shortcode: `[one_third]`**
     54
     55*Parameters*
     56
     57* first: Set to "Y" if it is the first one in the set
     58* last: Set to "Y" if it is the first one in the set
     59
     60Creates an element that is one third of it's container's width. **Required Parent: `[splits]`**
     61
     62**Shortcode: `[two_thirds]`**
     63
     64*Parameters*
     65
     66* first: Set to "Y" if it is the first one in the set
     67* last: Set to "Y" if it is the first one in the set
     68
     69Creates an element that is two thirds of it's container's width. **Required Parent: `[splits]`**
     70
     71**Shortcode: `[one_fourth]`**
     72
     73*Parameters*
     74
     75* first: Set to "Y" if it is the first one in the set
     76* last: Set to "Y" if it is the first one in the set
     77
     78Creates an element that is one fourth of it's container's width. **Required Parent: `[splits]`**
     79
     80**Shortcode: `[two_fourths]`**
     81
     82*Parameters*
     83
     84* first: Set to "Y" if it is the first one in the set
     85* last: Set to "Y" if it is the first one in the set
     86
     87Creates an element that is two fourths of it's container's width. **Required Parent: `[splits]`**
     88
     89**Shortcode: `[three_fourths]`**
     90
     91*Parameters*
     92
     93* first: Set to "Y" if it is the first one in the set
     94* last: Set to "Y" if it is the first one in the set
     95
     96Creates an element that is three fourths of it's container's width. **Required Parent: `[splits]`**
     97
     98**Shortcode: `[one_fifth]`**
     99
     100*Parameters*
     101
     102* first: Set to "Y" if it is the first one in the set
     103* last: Set to "Y" if it is the first one in the set
     104
     105Creates an element that is one fifth of it's container's width. **Required Parent: `[splits]`**
     106
     107**Shortcode: `[two_fifths]`**
     108
     109*Parameters*
     110
     111* first: Set to "Y" if it is the first one in the set
     112* last: Set to "Y" if it is the first one in the set
     113
     114Creates an element that is two fifths of it's container's width. **Required Parent: `[splits]`**
     115
     116**Shortcode: `[three_fifths]`**
     117
     118*Parameters*
     119
     120* first: Set to "Y" if it is the first one in the set
     121* last: Set to "Y" if it is the first one in the set
     122
     123Creates an element that is three fifths of it's container's width. **Required Parent: `[splits]`**
     124
     125**Shortcode: `[four_fifths]`**
     126
     127*Parameters*
     128
     129* first: Set to "Y" if it is the first one in the set
     130* last: Set to "Y" if it is the first one in the set
     131
     132Creates an element that is four fifths of it's container's width. **Required Parent: `[splits]`**
     133
     134**Shortcode: `[clear]`**
     135
     136*Parameters*
     137
     138* none
     139
     140Creates an element that does clear:both
     141
     142**Shortcode: `[more]`**
     143
     144*Parameters*
     145
     146* title: the text to display when content is hidden
     147 * Default: Learn More... / Spoilers...
     148
     149*Aliases*
     150* Spoiler
     151* Spoil
     152
     153Creates a link that shows a hidden area of content when clicked
     154
     155**Shortcode: `[tabs]`**
     156
     157*Parameters*
     158
     159* class: CSS class(es) to assign to the outer element
     160
     161Creates a tabbed area.
     162
     163**Shortcode: `tab`**
     164
     165*Parameters*
     166
     167* title: the tab's title
     168 * Default: New Tab
     169
     170Creates a tab  **Required Parent: `[tabs]`**
     171
     172**Shortcode: `[slider]`**
     173
     174*Parameters*
     175
     176* height: Height in css-compatible units.
     177 * Example: 400px
     178
     179Creates a slider container
     180
     181**Shortcode: `[slide]`**
     182
     183*Parameters*
     184
     185* none
     186* src: Background image.  Can be either url or media ID.
     187* href|slug|id|link : Where to go when the slide is clicked.  Can be a url, slug, post/page ID, or any other link format.
     188
     189Makes a slide.  **Required Parent: `[slider]`**
     190
     191**Shortcode: `[hover]`**
     192
     193*Parameters*
     194
     195* class: CSS class(es) to assign to the element
     196
     197Creates an area that toggles between two different content ares on hover
     198
     199**Shortcode: `[on]`**
     200
     201*Parameters*
     202
     203* none
     204
     205designates the content displayed when there is no hover.  **Required Parent: `[hover]`**
     206
     207**Shortcode: `[off]`**
     208
     209*Parameters*
     210
     211* none
     212
     213designates the content displayed when there is hover.  **Required Parent: `[hover]`**
     214
     215**Shortcode: `[background]`**
     216
     217*Parameters*
     218
     219* bgcolor: the background color
     220* src: Background image.  Can be either url or media ID.
     221* position: Background Position.
     222 * Default: top left
     223* repeat: Background Repeat.
     224 * Default: no-repeat
     225* height: Height in css-compatible units.
     226 * Example: 400px
     227* width: width in css-compatible units.
     228 * Example: 100%
     229 * Default: 100%
     230* class: CSS class(es) to assign to the element
     231* color: the foreground color
     232* padding: padding of element
     233 * Default: "0px 0px 0px 0px"
     234
     235creates a div with a background you set
     236
     237**Shortcode: `[flashcard]`**
     238
     239*Parameters*
     240
     241* height: Height in css-compatible units.
     242 * Example: 400px
     243* width: width in css-compatible units.
     244 * Example: 100%
     245 * Default: 100%
     246* class: CSS class(es) to assign to the element
     247
     248click to rotate from `[front]` to `[back]`
     249
     250**Shortcode: `[front]`**
     251
     252*Parameters*
     253
     254* click : what to click to toggle the flip
     255 * Default: all
     256 * Example: .close
     257
     258Front side of the FlashCard  **Required Parent: `[flashcard]`**
     259
     260**Shortcode: `[back]`**
     261
     262*Parameters*
     263
     264* click : what to click to toggle the flip
     265 * Default: all
     266 * Example: .close
     267
     268Back side of the FlashCard  **Required Parent: `[flashcard]`**
     269
     270**Shortcode: `[linkmap]`**
     271
     272*Parameters*
     273
     274* height: Height in css-compatible units.
     275 * Example: 400px
     276* width: width in css-compatible units.
     277 * Example: 100%
     278 * Default: 100%
     279* class: CSS class(es) to assign to the element
     280* src: Background image.  Can be either url or media ID.
     281* hover_src: Alternate Background image.  Can be either url or media ID.
     282* flashcard: Set to "y" to make clicking an area flip to the content of that area
     283* bgcolor: The background color
     284 * Default: transparent
     285
     286Image map replacement using divs.
     287Use one image for the background, then alter that image for all of the hover changes.
     288Create a `[maplink]` for each clickable area in the image.
     289
     290A clickable area in a linkmap  **Required Parent: `[linkmap]`**
     291
     292**Shortcode: `[link]`**
     293
     294*Parameters*
     295
     296* class: CSS class(es) to assign to the element
     297* href|slug|id|link : Where to go when the slide is clicked.  Can be a url, slug, post/page ID, or any other link format.
     298
     299Get a link
     300
     301**Shortcode: `[title]`**
     302
     303*Parameters*
     304
     305* id|slug : an identifier for the post/page/etc... to get the title for
     306
     307Get the title for a page/post/etc... in your WordPress install
     308
     309**Shortcode: `[buttons]`**
     310
     311*Parameters*
     312
     313* align: the alignment of the inner of the area
     314
     315Designate a area that holds buttons
     316
     317**Shortcode: `[button]`**
     318
     319*Parameters*
     320
     321* class: CSS class(es) to assign to the element
     322* title: the text displayed in the button
     323
     324Create a div that's a button so jQuery can be used on it
     325
     326= Full Examples =
    17327
    18328**Splits**
    … …  
    35345[/tabs]`
    36346
    37 = Short Codes =
    38 
    39 **Shortcode: `[splits]`**
    40 
    41 *Parameters*
    42 * None
    43 
    44 container for a row of splits
    45 
    46 **Shortcode: `[one_half]`**
    47 
    48 *Parameters*
    49 
    50 * first: Set to "Y" if it is the first one in the set
    51 * last: Set to "Y" if it is the first one in the set
    52 
    53 Creates an element that is one-half of it's container's width
    54 
    55 **Shortcode: `[one_third]`**
    56 
    57 *Parameters*
    58 
    59 * first: Set to "Y" if it is the first one in the set
    60 * last: Set to "Y" if it is the first one in the set
    61 
    62 Creates an element that is one third of it's container's width
    63 
    64 **Shortcode: `[two_thirds]`**
    65 
    66 *Parameters*
    67 
    68 * first: Set to "Y" if it is the first one in the set
    69 * last: Set to "Y" if it is the first one in the set
    70 
    71 Creates an element that is two thirds of it's container's width
    72 
    73 **Shortcode: `[one_fourth]`**
    74 
    75 *Parameters*
    76 
    77 * first: Set to "Y" if it is the first one in the set
    78 * last: Set to "Y" if it is the first one in the set
    79 
    80 Creates an element that is one fourth of it's container's width
    81 
    82 **Shortcode: `[two_fourths]`**
    83 
    84 *Parameters*
    85 
    86 * first: Set to "Y" if it is the first one in the set
    87 * last: Set to "Y" if it is the first one in the set
    88 
    89 Creates an element that is two fourths of it's container's width
    90 
    91 **Shortcode: `[three_fourths]`**
    92 
    93 *Parameters*
    94 
    95 * first: Set to "Y" if it is the first one in the set
    96 * last: Set to "Y" if it is the first one in the set
    97 
    98 Creates an element that is three fourths of it's container's width
    99 
    100 **Shortcode: `[clear]`**
    101 
    102 *Parameters*
    103 
    104 * none
    105 
    106 Creates an element that does clear:both
    107 
    108 **Shortcode: `[more]`**
    109 
    110 *Parameters*
    111 
    112 * title: the text to display when content is hidden
    113  * Default: Learn More... / Spoilers...
    114 
    115 *Aliases*
    116 * Spoiler
    117 * Spoil
    118 
    119 Creates a link that shows a hidden area of content when clicked
    120 
    121 **Shortcode: `[tabs]`**
    122 
    123 *Parameters*
    124 
    125 * class: CSS class(es) to assign to the outer element
    126 
    127 Creates a tabbed area, `[tab]` designates it's children
    128 
    129 **Shortcode: `tab`**
    130 
    131 *Parameters*
    132 
    133 * title: the tab's title
    134  * Default: New Tab
    135 
    136 Creates a tab, to be used inside of `[tabs]`
    137 
    138 **Shortcode: `[slider]`**
    139 
    140 *Parameters*
    141 
    142 * height: Height in css-compatable units.
    143  * Example: 400px
    144 
    145 Creates a slider area, `[slide]` designates it's children
    146 
    147 **Shortcode: `[slide]`**
    148 
    149 *Parameters*
    150 
    151 * none
    152 * src: Background image.  Can be either url or media ID.
    153 * href|slug|id|link : Where to go when the slide is clicked.  Can be a url, slug, post/page ID, or any other link format.
    154 
    155 Makes a slide to be used inside of `[slider]`
    156 
    157 **Shortcode: `[hover]`**
    158 
    159 *Parameters*
    160 
    161 * class: CSS class(es) to assign to the element
    162 
    163 Creates an area that togges between two different content ares on hover
    164 
    165 **Shortcode: `[on]`**
    166 
    167 *Parameters*
    168 
    169 * none
    170 
    171 designates the area displayed before hover inside of `[hover]`
    172 
    173 **Shortcode: `[off]`**
    174 
    175 *Parameters*
    176 
    177 * none
    178 
    179 designates the area displayed with hover inside of `[hover]`
    180 
    181 
    182 
    183 **Shortcode: `[background]`**
    184 
    185 *Parameters*
    186 
    187 * bgcolor: the background color
    188 * src: Background image.  Can be either url or media ID.
    189 * position: Background Position.
    190  * Default: top left
    191 * repeat: Background Repeat.
    192  * Default: no-repeat
    193 * height: Height in css-compatable units.
    194  * Example: 400px
    195 * width: width in css-compatable units.
    196  * Example: 100%
    197  * Default: 100%
    198 * class: CSS class(es) to assign to the element
    199 * color: the foreground color
    200 * padding: padding of element
    201  * Default: "0px 0px 0px 0px"
    202 
    203 creates a div with a background you set
    204 
    205 **Shortcode: `[flashcard]`**
    206 
    207 *Parameters*
    208 
    209 * height: Height in css-compatable units.
    210  * Example: 400px
    211 * width: width in css-compatable units.
    212  * Example: 100%
    213  * Default: 100%
    214 * class: CSS class(es) to assign to the element
    215 
    216 click to rotate from `[front]` to `[back]`
    217 
    218 **Shortcode: `[front]`**
    219 
    220 *Parameters*
    221 
    222 * click : what to click to toggle the flip
    223  * Default: all
    224  * Example: .close
    225 
    226 Front side of the FlashCard
    227 
    228 **Shortcode: `[back]`**
    229 
    230 *Parameters*
    231 
    232 * click : what to click to toggle the flip
    233  * Default: all
    234  * Example: .close
    235 
    236 Back side of the FlashCard
    237 
    238 **Shortcode: `[linkmap]`**
    239 
    240 *Parameters*
    241 
    242 * height: Height in css-compatable units.
    243  * Example: 400px
    244 * width: width in css-compatable units.
    245  * Example: 100%
    246  * Default: 100%
    247 * class: CSS class(es) to assign to the element
    248 * src: Background image.  Can be either url or media ID.
    249 * hover_src: Alternate Background image.  Can be either url or media ID.
    250 * flashcard: Set to "y" to make clicking an area flip to the content of that area
    251 * bgcolor: The background color
    252  * Default: transparent
    253 
    254 Image map replacement using divs.
    255 Use one image for the background, then alter that image for all of the hover changes.
    256 Create a `[maplink]` for each clickable area in the image.
    257 
    258 A clickable area in a linkmap
    259 
    260 **Shortcode: `[link]`**
    261 
    262 *Parameters*
    263 
    264 * class: CSS class(es) to assign to the element
    265 * href|slug|id|link : Where to go when the slide is clicked.  Can be a url, slug, post/page ID, or any other link format.
    266 
    267 Get a link
    268 
    269 **Shortcode: `[title]`**
    270 
    271 *Parameters*
    272 
    273 * id|slug : an identifier for the post/page/etc... to get the title for
    274 
    275 Get the title for a page/post/etc... in your wordpress install
    276 
    277 **Shortcode: `[buttons]`**
    278 
    279 *Parameters*
    280 
    281 * align: the alignment of the inner of the area
    282 
    283 Designate a area that holds buttons
    284 
    285 **Shortcode: `[button]`**
    286 
    287 *Parameters*
    288 
    289 * class: CSS class(es) to assign to the element
    290 * title: the text displayed in the button
    291 
    292 Create a div that's a button so jquery can be used on it
     347**Link & Title**
     348`This will contain a link to the page whose id is 5 and it's title: [link id="5"][title id="5"][/link]`
    293349
    294350= Future Plans =
    … …  
    296352* Code Comments
    297353* Examples / How to
    298 * TinyMCE Integration - waiting for WP 3.9 (TinyMCE v4)
     354* Document advanced shortcodes better, get screenshots/video of them in action:
     355 * Linkmap
     356 * FlashCard
     357 * Slider
     358* TinyMCE Integration
    299359 * Buttons to create/edit shortcodes
    300  * Content filters that display shortcodes output in the editor and when focused on allow you to click the aformentioned button again to edit it's info - like bold or italic
     360 * Content filters that display shortcodes output in the editor and when focused on allow you to click the aforementioned button again to edit it's info - like bold or italic
    301361
    302362= Known Issues =
    303363
    304 * `[email_form]` needs to be tied into wordpress' email system and should actually send out an email
    305 * `[person]` needs formatting like I need therapy
     364* `[email_form]` needs to be tied into WordPress' email system and should actually send out an email
     365* `[person]` needs formatting
    306366
    307367== Screenshots ==
    … …  
    318378
    319379== Changelog ==
     380= 4.0 =
     381Added better documentation
     382Added a "How to read" section to the documentation.
     383Better format for documenting the required parent shortcode for shortcodes that require them.
     384Spell checked the Documentation.
     385
    320386= 3.8.07 =
    321387Added fifth splits
    … …  
    336402 * Slider "first" property - make it work in other themes
    337403 * Slider now uses src parameter instead of altering it's content to get an image
    338 * Removing Dependancy on php 5.3
     404* Removing Dependency on php 5.3
    339405* Removing development error reporting
    340406* Making Class Based
    … …  
    348414= 2.2 =
    349415* Cleanup
    350 * Added various parameter alias's
     416* Added various parameter aliases
    351417* Added link
    352418* Added title
    … …  
    362428
    363429= 3.3 =
    364 Bugfix for the severe error that was happening in 3.0 - 3.2
     430Bug-fix for the severe error that was happening in 3.0 - 3.2
    365431You'll want the background shortcode... trust me
Note: See TracChangeset for help on using the changeset viewer.