WordPress.org
Get WordPress

Plugin Directory

Changeset 540573


Ignore:
Timestamp:
05/06/2012 08:17:43 PM (14 years ago)
Author:
dylanized
Message:

fixed readme for 1.4

File:
1 edited

Legend:

Unmodified
Added
Removed

  • wp-lipsum/trunk/readme.txt

    r540569 r540573  
    11=== Plugin Name ===
    2 Contributors: dylanized (this should be a list of wordpress.org userid's)
     2Contributors: dylanized
    33Tags: dummy text, lorem ipsum, lipsum
    44Requires at least: 3.3.2
    … …  
    88License URI: http://www.gnu.org/licenses/gpl-2.0.html
    99
    10 WP Lipsum is a simple plugin for generating dummy text for your WordPress site.
     10WP-Lipsum is a simple plugin for generating dummy text for your WordPress site.
    1111
    1212== Description ==
    1313
    14 WP Lipsum includes a collection of template fragments representing lots of common page types, from simple lorem ipsum paragraphs to demos of the WP comment system, and more. It works via shortcode or template tag.
     14WP-Lipsum includes a collection of template fragments representing lots of common page types, from simple lorem ipsum paragraphs to demos of the WP comment system, and more. It works via a simple shortcode or template tag.
    1515
    16 = Shortcodes =
     16= Using the Shortcode =
    1717
    18 Here are the basic shortcodes you can use.
    19 
    20 [lipsum]
     18`[lipsum]`
    2119This outputs the basic content block. You can edit this in wp-lipsum/templates/basic.php.
    2220
    23 [lipsum template=aux]
     21`[lipsum template=aux]`
    2422This outputs the auxilary lipsum page, with tables, definition lists, and more. You can edit this in templates/aux.php.
    2523
    26 [lipsum repeat=4]
     24`[lipsum repeat=4]`
    2725This outputs 4 simple paragphs of lorem ipsum text. You can edit the text in templates/p.php.
    2826
    29 [lipsum template=ol repeat=3]
     27`[lipsum template=ol repeat=3]`
    3028This loads the ordered list template and displays it 3 times.
    3129
    32 [lipsum t=ol r=3]
     30`[lipsum t=ol r=3]`
    3331You can also use “t” and “r” as parameter shortcuts.
    3432
    … …  
    3735For the image templates, you can also pass in custom dimensions with the "width", "height" and "align" parameters (shorcuts w, h and a). This works for the img, caption, portfolio & portfolio_item, and gallery & gallery_item templates.
    3836
    39 [lipsum template=img width=300 height=150]
     37`[lipsum template=img width=300 height=150]`
    4038
    41 [lipsum t=caption w=300 h=150 a=right]
     39`[lipsum t=caption w=300 h=150 a=right]`
    4240
    43 [lipsum t=gallery w=500 h=220]
     41`[lipsum t=gallery w=500 h=220]`
    4442
    45 [lipsum t=portfolio w=100 h=100]
     43`[lipsum t=portfolio w=100 h=100]`
    4644
    47 Align can be "left", "right", "center" or "none". The dimensions default to 200x200, and alignleft.
     45Align can be set to "left", "right", "center" or "none". These parameters default to 200x200, and alignleft.
    4846
     47= Lipsum Templates and Fragments =
    4948
    50 = Lipsum Templates =
     49Here are the full pages of lipsum content available:
    5150
    52 Here are the full lipsum pages you can call:
     51* Basic Content – “basic”
     52* Aux Content – “aux”
     53* Blog Demo – “blog”
     54* Single Post Demo – “single”
     55* Headline List – “headline_list”
     56* Gallery Demo – “gallery”
     57* Portfolio Demo – “portfolio”
     58* Long Header Examples – “long_headers”
     59* Short Content Demo – “short”
     60* Template Fragments
    5361
    54 Basic Content – “basic”
    55 Aux Content – “aux”
    56 Blog Demo – “blog”
    57 Single Post Demo – “single”
    58 Headline List – “headline_list”
    59 Gallery Demo – “gallery”
    60 Portfolio Demo – “portfolio”
    61 Long Header Examples – “long_headers”
    62 Short Content Demo – “short”
    63 Template Fragments
    64 
    65 You can also call these smaller template fragments, and use the “repeat” parameter:
     62You can also call these smaller fragments, and use the “repeat” parameter:
    6663
    6764* Single Paragraph – “p”
    … …  
    7269* Blockquote – “blockquote”
    7370* Blog Teaser – “blog_teaser”
    74 * WP Image Caption Demo – “caption”
     71* Image (without caption) - "img"
     72* Image with WP Caption - "caption"
    7573* Code Demo – “code”
    7674* Comments Demo – “comments”
    … …  
    8583Templates use Bedrock conventions, including class names (like .table-style and .post-nav), using H1s and H2s only for titles, and other concepts.
    8684
    87 = Template Tags =
     85= Using the Template Tag =
    8886
    89 You can also call the plugin from the template code, by using these template tags:
     87You can also call the plugin from your theme code, by using the display_lipsum)_template() function:
    9088
    9189`<?php display_lipsum_template($template, $repeat); ?>`
    92 `<?php display_lipsum_template(‘basic’) ?>' (this would include the basic.php template)
    93 `<?php display_lipsum_template(‘table’, 4) ?>' ( this would include the table.php fragment and repeat it 4 times)
    94 `<?php display_lipsum_template(‘caption’, 1, 500, 300) ?>' ( this would include the caption.php fragment and give the image 500x300 dimensions)
     90`<?php display_lipsum_template('basic') ?>`
     91`<?php display_lipsum_template('table', 4) ?>`
     92`<?php display_lipsum_template('caption', 1, 500, 300, 'right') ?>'
    9593
    9694= More Info =
    9795
    98 [WPLipsum](http://bedrocktheme.com/wp-lipsum/ "View the WP-Lipsum homepage here")
     96[View the WP-Lipsum homepage here](http://bedrocktheme.com/wp-lipsum/ "View the WP-Lipsum homepage here")
    9997
    100 WP-Lipsum is a part of the Bedrock mini-framework, more info at [Bedrock](http://bedrocktheme.com/ "bedrocktheme.com")
     98WP-Lipsum is a part of the Bedrock mini-framework, more info at [bedrocktheme.com](http://bedrocktheme.com/ "bedrocktheme.com")
     99
     100Follow me at [dylanized.com](http://dylanized.com/ "dylanized.com") and [@dylanized](http://twitter.com/dylanized "@dylanized")
    101101
    102102
    … …  
    120120
    121121= 1.3 =
    122 * Added "t" and "r" shortcuts, subitted to WP Directory
     122* Added "t" and "r" shortcuts, submitted to WP Directory
    123123
    124124= 1.2 =
Note: See TracChangeset for help on using the changeset viewer.