WordPress.org
Get WordPress

Plugin Directory

Changeset 538685


Ignore:
Timestamp:
05/01/2012 08:22:44 PM (14 years ago)
Author:
m.wagner
Message:
 
File:
1 edited

Legend:

Unmodified
Added
Removed

  • dive-log-book/trunk/readme.txt

    r357891 r538685  
    11=== Plugin Name ===
    2 Contributors: mwagner80 (this should be a list of wordpress.org userid's)
     2Contributors: mwagner80
    33Donate link: http://www.blue-design.ch/
    44Tags: scuba, diving, log, logbook
    55Requires at least: 3.0
    66Tested up to: 3.0
    7 Stable tag: 4.3
     7Stable tag: 0.1
    88
    9 Here is a short description of the plugin.  This should be no more than 150 characters.  No markup here.
     9The plugin will be available soon.
    1010
    1111== Description ==
    12 
    13 This is the long description.  No limit, and you can use Markdown (as well as in the following sections).
    14 
    15 For backwards compatibility, if this section is missing, the full length of the short description will be used, and
    16 Markdown parsed.
    17 
    18 A few notes about the sections above:
    19 
    20 *   "Contributors" is a comma separated list of wp.org/wp-plugins.org usernames
    21 *   "Tags" is a comma separated list of tags that apply to the plugin
    22 *   "Requires at least" is the lowest version that the plugin will work on
    23 *   "Tested up to" is the highest version that you've *successfully used to test the plugin*. Note that it might work on
    24 higher versions... this is just the highest one you've verified.
    25 *   Stable tag should indicate the Subversion "tag" of the latest stable version, or "trunk," if you use `/trunk/` for
    26 stable.
    27 
    28     Note that the `readme.txt` of the stable tag is the one that is considered the defining one for the plugin, so
    29 if the `/trunk/readme.txt` file says that the stable tag is `4.3`, then it is `/tags/4.3/readme.txt` that'll be used
    30 for displaying information about the plugin.  In this situation, the only thing considered from the trunk `readme.txt`
    31 is the stable tag pointer.  Thus, if you develop in trunk, you can update the trunk `readme.txt` to reflect changes in
    32 your in-development version, without having that information incorrectly disclosed about the current stable version
    33 that lacks those changes -- as long as the trunk's `readme.txt` points to the correct stable tag.
    34 
    35     If no stable tag is provided, it is assumed that trunk is stable, but you should specify "trunk" if that's where
    36 you put the stable version, in order to eliminate any doubt.
     12The plugin will be available soon as an update.
    3713
    3814== Installation ==
    39 
    40 This section describes how to install the plugin and get it working.
    41 
    42 e.g.
    43 
    44 1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory
     151. Upload `dive-log-book` to the `/wp-content/plugins/` directory
    45161. Activate the plugin through the 'Plugins' menu in WordPress
    46 1. Place `<?php do_action('plugin_name_hook'); ?>` in your templates
    4717
    4818== Frequently Asked Questions ==
    4919
    50 = A question that someone might have =
    51 
    52 An answer to that question.
    53 
    54 = What about foo bar? =
    55 
    56 Answer to foo bar dilemma.
    57 
    5820== Screenshots ==
    59 
    60 1. This screen shot description corresponds to screenshot-1.(png|jpg|jpeg|gif). Note that the screenshot is taken from
    61 the directory of the stable readme.txt, so in this case, `/tags/4.3/screenshot-1.png` (or jpg, jpeg, gif)
    62 2. This is the second screen shot
    6321
    6422== Changelog ==
    … …  
    6927== Arbitrary section ==
    7028
    71 You may provide arbitrary sections, in the same format as the ones above.  This may be of use for extremely complicated
    72 plugins where more information needs to be conveyed that doesn't fit into the categories of "description" or
    73 "installation."  Arbitrary sections will be shown below the built-in sections outlined above.
    74 
    7529== A brief Markdown Example ==
    76 
    77 Ordered list:
    78 
    79 1. Some feature
    80 1. Another feature
    81 1. Something else about the plugin
    82 
    83 Unordered list:
    84 
    85 * something
    86 * something else
    87 * third thing
    88 
    89 Here's a link to [WordPress](http://wordpress.org/ "Your favorite software") and one to [Markdown's Syntax Documentation][markdown syntax].
    90 Titles are optional, naturally.
    91 
    92 [markdown syntax]: http://daringfireball.net/projects/markdown/syntax
    93             "Markdown is what the parser uses to process much of the readme file"
    94 
    95 Markdown uses email style notation for blockquotes and I've been told:
    96 > Asterisks for *emphasis*. Double it up  for **strong**.
    97 
    98 `<?php code(); // goes in backticks ?>`
    99 
Note: See TracChangeset for help on using the changeset viewer.