Plugin Directory

Changeset 759748

08/21/13 06:27:39 (5 years ago)

deploy from git

1 added
1 edited


  • ep-admin-messages/trunk/readme.txt

    r759747 r759748  
    1 ep-admin-messages 
    2 ================= 
     1=== EP Admin Messages === 
     2Contributors: EarthPeople, eskapism 
     3Donate link: http://earthpeople.se/ 
     4License: GPLv3 
     5License URI: http://www.gnu.org/licenses/gpl.html 
     6Tags: admin, wp admin, wordpress admin, messages, notices, information, client, help 
     7Requires at least: 3.6 
     8Tested up to: 3.6 
     9Stable tag: 0.1 
    4 Show messages in WP Admin 
     11Show messages in WP Admin. Different messages can be shown at different places, for different people. 
    6 Plugin från EarthPeople för att informera kunder om saker i admin. 
     13== Description == 
    8 == Todo == 
     15With EP Admin Messages you can show messages in the admin area of WordPress. 
    10  - [x] Get the plugin the kinda work 
    11  - [x] Add option so messages can be put in metabox on dashboard and post type 
    12  - [ ] All messages should fit in one metabox 
    13  - [ ] Show info on mouse over, telling who can see the box (so admin can be sure that json capability filter is being read) 
    14  - [ ] Write this file in english 
    15  - [ ] Make this file a proper wp readme 
    16  - [ ] Add files for translation 
    17  - [ ] Update example config with all options 
    18  - [ ] Make a build script that automagically pushes a new svn version based on this git version 
     17= Locations where messages can be shown = 
    20 == Tankar och idéer: == 
     19You have full control over where your messages will be shown.  
     20Each message can be placed in one or several of the following places: 
    22 - All konfigurering sköts via en .json-fil som läggs i temats katalog. 
    23 - Ligger i tema-mappen = anpassas för just temat och för de post types etc. som ligger just där 
    24 - Ska vara enkelt och tydligt att konfigurera. Inte för många alternativ. 
     22* on the dashboard 
     23* on the overview screen for posts, pages, and custom post types 
     24* on the edit screen for posts, pages and custom post types 
     25* on posts with a specific slug or a slug based on a wildcard 
     26* on the user overview screen and on user profiles 
     27* on the plugin page 
    26 == Funktionalitet == 
     29= Use capabilities to limit who can see what = 
    28 - Platser: 
    29   - dashboard 
    30   - vid redigering av  posts/pages 
    31   - överssiktssida/posts overview screen - för att skriva beskrivning om vad en post type används för 
    32 - Vilken text som visas var beror på: 
    33 - Vilken capability en användare har, t.ex. en text för admins och en annan för editors. 
    34 - Vilken post type som visas 
    35 - Vilken slug den har. Konfig ska stödja wildcards så en infotext kan visas på alla sidor som har en slug som börjar med `text-header-*` och då visas den alltså på både `text-header-intro` och `text-header-banner` 
    36 - Flera infotexter kan visas på en sida, så infopaketet skräddarsyns för just den användaren 
     31Each message can be limited to be shown only to users with a specific [capability](http://codex.wordpress.org/Glossary#Capabilities). 
     33You can for example show one message to your editors, i.e. users with the capability "edit_posts", and another message to your admins, i.e. users with the capability "manage_options". 
     35= Limit messages to posts with specific slugs = 
     37Messages can be limited to only be shown on posts that match a specific slug, or a slug that matches a wildcard. 
     39This way it's easy to for example show page specific information, letting a user know what a page is for, what they should put in in, and so on. 
     41= Controlled by JSON = 
     43All settings are made with a config file that you put in the theme directory. 
     44This means that there are no settings for the user to change. This also means that you can add messages using your regular deploy method. Just upload an updated config file and you're done. No database syncing needed; hooray! 
     46= Usage scenarios = 
     48To give you an idea what this plugin may be used for, I'll give you a list of what I do with it. 
     50I'm using EP Simple Messags to: 
     52* ... write documentation for users and developers. 
     53* ... show editors what [Mustache tags](http://mustache.github.io/) are available for a specific post (controlled by post slug). You know, things like `{{user.firstname}}` or `{{campaign.name}}`, that there is no way that they (or I!) will ever remember. 
     54* ... show a message on the dashboard with support info, like who made the site and who they should contact for support questions. 
     55* ... let the user know what shortcodes that are available for all posts. 
    39 == Användningsexempel: == 
     58== Installation == 
    41 - Skriva dokumentation för admins eller användare. 
    42 - Ange info om en specifik sida vilka tags som finns tillgänglig, t.ex. `%s` för förnamn eller `{{user.fornamn}}` beroende på vilket sätt man skapar mallarna. Gäller främst på post-nivå. 
    43 - Visa text på dashboard där det står att Earth People skapat sajten och att dom ska hörav sig till peder@earthpeople.se om dom har frågor eller pengar dom vill bli av med. Gäller för alla/allt/hela rubbet. 
    44 - Informera om vilka shortcodes som finns tillgängliga. Gäller på sajt-nivå, eller kanske post-type-nivå. 
     601. Upload the plugin folder to your `/wp-content/plugins/` directory 
     611. Activate the plugin through the 'Plugins' menu in WordPress 
     621. Add a file called `ep-config.json` to your theme directory. This file contains your config in JSON-format.  
     64== Screenshots == 
    47 == Så här kommer det se ut. Typ. == 
     661. .... 
     672. .... 
    49 **På dashboard.** 
    50 ![På dashboard](https://dl.dropboxusercontent.com/u/171101/earthpeople/infobox-example-1.png) 
     69== Changelog == 
    52 **På en sida.** 
    53 Texten ovanför strecket/hr visas bara för admins medan texten under visas för både admins och vanliga användare. 
    54 ![På en sida](https://dl.dropboxusercontent.com/u/171101/earthpeople/infobox-example-2.png) 
     71= 0.1 = 
     73* First working version. 
Note: See TracChangeset for help on using the changeset viewer.