Plugin Directory

Changeset 1120610


Ignore:
Timestamp:
03/25/2015 04:38:28 PM (11 years ago)
Author:
seoringer
Message:

Readme.txt change #9

File:
1 edited

Legend:

Unmodified
Added
Removed
  • simple-voting/trunk/README.txt

    r1120601 r1120610  
    3737<br>That's all you need to know about simplest using of the Simple Voting plugin.
    3838<br>
     39<br>
    39402. <strong>Voting for arbitrary subjects</strong>
    4041<br>
    4142<br>If you want to allow your visitors to vote for an arbitrary subject, you must use more complex shortcode
    4243construction, like this:
    43 <br><strong>[voting]Arbitrary subject name[/voting]</strong>
     44<br><strong>[voting] Arbitrary subject name [/voting]</strong>
    4445<br>
    4546<br>Such block of code could be placed in any article, and will rate the same <strong>'Arbitrary subject name'</strong>.
    4647<br>To show the rating of the <strong>'Arbitrary subject name'</strong>, use following shortcode:
    47 <br><strong>[voted]Arbitrary subject name[/voted]</strong>
     48<br><strong>[voted] Arbitrary subject name [/voted]</strong>
    4849<br>
    4950<br>
     
    5455<br>Let's imagine, that after voting, you want to send visitor to the URL http://somesite.com/somepage.php
    5556<br>To do so, you must write something like this:
    56 <br><strong>[voting]http://somesite.com/somepage.php Subject name[/voting]</strong>
     57<br><strong>[voting] http://somesite.com/somepage.php Subject name [/voting]</strong>
    5758<br>
    5859<br>Or something like this:
    59 <br><strong>
    60 <br>[voting]
     60<br><strong>[voting]
    6161<br>Another
    6262<br>subject
    6363<br>http://somesite.com/somepage.php
    64 <br>[/voting]
    65 <br></strong>
     64<br>[/voting]</strong>
    6665<br>
    6766<br>Or just that:
    6867<br>
    69 <br><strong>[voting]http://somesite.com/somepage.php[/voting]</strong>
     68<br><strong>[voting] http://somesite.com/somepage.php [/voting]</strong>
    7069<br>
    7170<br>Note that although in all these examples I used same URL (http://somesite.com/somepage.php),  they are
    7271DIFFERENT voting subjects, because texts inside shortcode tags are different.
    7372<br>
    74 <br>Note. To show the rating of the subjects from above examples, you must use <strong>[voted]</strong> shortcode
     73<br>To show the rating of the subjects from above examples, you must use <strong>[voted]</strong> shortcode
    7574instead of <strong>[voting]</strong> one. Like this:
    7675<br>
    77 <br><strong>[voted]http://somesite.com/somepage.php Subject name[/voted]</strong>
     76<br><strong>[voted] http://somesite.com/somepage.php Subject name [/voted]</strong>
    7877<br>
    7978<br><strong>[voted]
     
    8382<br>[/voted]</strong>
    8483<br>
    85 <br><strong>[voted]http://somesite.com/somepage.php[/voted]</strong>
     84<br><strong>[voted] http://somesite.com/somepage.php [/voted]</strong>
    8685<br>
    8786<br>After voting on any of these subjects, user will be sent to the given web page
    88 (http://somesite.com/somepage.php in our examples). To this page also will be POSTed data, containing
     87(in our examples http://somesite.com/somepage.php). To this page also will be POSTed data, containing
    8988following information about voting subject:
    9089<br>
    91 <br><strong>sv_vote</strong> – user’s vote (from 1 to 10)
    92 <br><strong>sv_textID</strong> – unique subject identifier, which consists of three letters and numeric ID.
    93 <br><strong>svUserName</strong> – user name
    94 <br><strong>svUserEmail</strong> – user’s Email
    95 <br><strong>svUserComment</strong> – user’s comment
    96 <br><strong>sv_nonce</strong> – one time code, generated by the function: wp_create_nonce( 'simple-voting' ).
    97 This code used for security purposes, but you may ignore it.
     90<br><strong>sv_vote</strong>: user’s vote (from 1 to 10)
     91<br><strong>sv_textID</strong>: unique subject identifier, which consists of three letters and numeric ID.
     92<br><strong>svUserName</strong>: user name
     93<br><strong>svUserEmail</strong>: user’s Email
     94<br><strong>svUserComment</strong>: user’s comment
     95<br><strong>sv_nonce</strong>: one time security code, generated by the function: wp_create_nonce( 'simple-voting' ).
    9896<br>
    9997<br>
    100984. <strong>Database tables</strong>
    10199<br>
    102 <br>Simple voting plugin stores all information in two database tables:
     100<br>Simple voting plugin stores all information just in two database tables:
    103101<br><strong>
    104 </br>{db_prefix}simple_voting_subjects
    105 </br>{db_prefix}simple_voting_votes
     102<br>{db_prefix}simple_voting_subjects
     103<br>{db_prefix}simple_voting_votes
    106104<br></strong>
    107105<br>
Note: See TracChangeset for help on using the changeset viewer.