Changeset 1553

Show
Ignore:
Timestamp:
06/05/09 16:24:34 (6 months ago)
Author:
bsmith
Message:

updating readme

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/Vanilla/README.txt

    r1255 r1553  
    11## Vanila, a plugin for Movable Type 
    2 ## Author: Beau Smith, beau at sixapart com 
     2## Author: Beau Smith at Six Apart 
    33## Version: 0.1 
    44## Released under GPL 
    55 
    6 ## OVERVIEW ## 
     6## Overview 
    77 
    8     A series of template sets to learn about specific features in Movable Type. 
     8Vanilla provides various template sets which contain the minimal amount of code necessary to show a specific feature in Movable Type. These template sets are not indended to be used for publishing your blog, rather they to be used for learning how to add a particular feature. 
    99 
    10 ## PREREQUISITES ## 
     10### Prerequisites 
    1111 
    12     Requires Movable Type 4.2 for most features. 
     12* **Movable Type 4.2** for most features 
     13* **Score Plugin** for Vanilla + Scoring template set 
    1314 
    14 ## FEATURES ## 
     15### Usage 
    1516 
    16     Template Sets 
     171. Create a new test blog using the template set with the desired feature. Perhaps call it "Vanilla" 
     182. Add content to Vanilla blog based upon requirements of feature 
     19    * create entries in the past to use **Vanilla + Archives** 
     20    * add comments for **Vanilla + Comments** 
     21    * upload images to use **Vanilla + Assets** 
     223. Republish the Vanilla blog 
     234. Copy necessary template code for desired features into your production blog 
    1724 
    18     1. Vanilla 
    19         - Lastn entries on Homepage 
    20         - Entry Detail 
     25### Tips 
    2126 
    22     2. Vanilla + Archives 
    23         - Base homepage & entries 
    24         - Archive Index 
    25         - Archives: Monthly, Author, Category and Category-Monthly 
    26         - Navigation w/ Category-Monthly links on Category Archives 
     27* When pasting templates with \_trans tags, MT will convert all translation strings upon save. So you can also [browse the templates via SVN](http://code.sixapart.com/svn/mtplugins/trunk/Vanilla/templates/) and then copy/paste them into MT template editing screen. _Of course this tip applies to all template sets_ 
    2728 
    28     3. Vanilla + Pages 
    29         - Base homepage & entries 
    30         - Pages 
    31         - Navigation including Pages 
     29### Templates Sets 
    3230 
    33     4. Vanilla + Authentication & Userpics 
    34         - En/disable userpics in javascript 
    35         - Use of community "edit profile" script is necessary to add userpics. The "edit profile" page assumes that you are using profiles and thus links to "view profile" screen. If using profiles is not desired, the "view profile" link can be removed from the "Profile Edit" Global System Template. 
     311. **Vanilla** 
     32    * Lastn entries on Homepage 
     33    * Entry Detail 
     342. **Vanilla + Archives** 
     35    * Base homepage & entries 
     36    * Archive Index 
     37    * Archives: Monthly, Author, Category and Category-Monthly 
     38    * Navigation w/ Category-Monthly links on Category Archives 
     393. **Vanilla + Pages** 
     40    * Base homepage & entries 
     41    * Pages 
     42    * Navigation including Pages 
     434. **Vanilla + Authentication & Userpics** 
     44    * En/disable userpics in javascript 
     45    * Use of community "edit profile" script is necessary to add userpics. The "edit profile" page assumes that you are using profiles and thus links to "view profile" screen. If using profiles is not desired, the "view profile" link can be removed from the "Profile Edit" Global System Template. 
     465. **Vanilla + Comments** 
     47    * Authentication 
     48    * Comments 
     49    * Comment reply links 
     50    * Comment Preview 
     51    * Comment Response 
     526. **Vanilla + Comments w/ Userpics** 
     53    * Authentication w/ userpic 
     54    * Comments w/ userpics 
     55    * Comment reply links 
     56    * Comment Preview 
     57    * Comment Response 
     58    * En/disable userpics in javascript 
     59    * Use of community "edit profile" script is necessary to add userpics. The "edit profile" page assumes that you are using profiles and thus links to "view profile" screen. If using profiles is not desired, the "view profile" link can be removed from the "Profile Edit" Global System Template. 
     607. **Vanilla + Create Entry** 
     61    * Authentication 
     62    * Create Entry 
     63    * Entry Response 
     648. **Vanilla + Search & Tags** 
     65    * Tag Cloud and Search Form on Homepage 
     66    * Entry Detail 
     67    * Page Detail 
     68    * Search Results Template 
     699. **Vanilla + Assets** 
     70    * Recent assets on Homepage in various sizes and formats 
     71    * lastn entries on Homepage with the first asset added to each as 70 pixel square 
     72    * Entry Detail with assets in entries 
     7310. **Vanilla + Widgets** 
     74    * Homepage with one widget set and individually included widget: 
     75        * Search 
     76        * Tag Cloud 
     77        * Monthly Archives 
     78        * Recent Entries 
     79        * Page Listing 
     80        * About Site 
     81    * Entry Detail with a second widget set and individually included widget: 
     82        * Search 
     83        * Tag Cloud 
     84        * Monthly Archives 
     85        * About Site 
     8611. **Vanilla + Scoring** (beta) 
    3687 
    37     5. Vanilla + Comments 
    38         - Authentication 
    39         - Comments 
    40         - Comment reply links 
    41         - Comment Preview 
    42         - Comment Response 
     88    This template set works, but needs to be updated to take advantage of the latest updates to the [Scoring Plugin which is available via SVN only](http://code.sixapart.com/svn/mtplugins/trunk/Score/). 
    4389 
    44     6. Vanilla + Comments w/ Userpics 
    45         - Authentication w/ userpic 
    46         - Comments w/ userpics 
    47         - Comment reply links 
    48         - Comment Preview 
    49         - Comment Response 
    50         - En/disable userpics in javascript 
    51         - Use of community "edit profile" script is necessary to add userpics. The "edit profile" page assumes that you are using profiles and thus links to "view profile" screen. If using profiles is not desired, the "view profile" link can be removed from the "Profile Edit" Global System Template. 
     90    Tip: to remove all scoring for a particular namespace, use this SQL command: 
    5291 
    53     7. Vanilla + Create Entry 
    54         - Authentication 
    55         - Create Entry 
    56         - Entry Response 
     92        delete from mt_objectscore where objectscore_namespace = 'NAMESPACE'; 
    5793 
    58     8. Vanilla + Search & Tags 
    59         - Tag Cloud and Search Form on Homepage 
    60         - Entry Detail 
    61         - Page Detail 
    62         - Search Results Template 
    63         - Notes: 
    64             - Can someone explain how mt-search determines which search template to use for rendering results?  If it’s by the value of the IncludeBlogs input, which blog id takes precedence? Does the new mt-search still support the ExcludeBlogs input? 
    65             - It’s IncludeBlogs.  It uses the first blog_id in the comma separated list.  And yes, ExcludeBlogs does work as it has been before. 
    66  
    67     9. Vanilla + Assets 
    68         - Recent assets on Homepage in various sizes and formats 
    69         - lastn entries on Homepage with the first asset added to each as 70 pixel square 
    70         - Entry Detail with assets in entries 
    71  
    72     10. Vanilla + Widgets 
    73         - Homepage with one widget set and individually included widget: 
    74             - Search 
    75             - Tag Cloud 
    76             - Monthly Archives 
    77             - Recent Entries 
    78             - Page Listing 
    79             - About Site 
    80         - Entry Detail with a second widget set and individually included widget: 
    81             - Search 
    82             - Tag Cloud 
    83             - Monthly Archives 
    84             - About Site 
    85     11. Vanilla + Scoring 
    86          
    87         Tip: to remove all scoring for a particular namespace, use this SQL command: 
    88          
    89             delete from mt_objectscore where objectscore_namespace = 'NAMESPACE'; 
    90  
    91     12. Vanilla + TypePad Connect Commenting 
    92         - Sample implementation of TypePad Connect Commenting. 
    93         - Abstracting Configuration into Module 
    94         - Option for integrating MT and TP comments 
     9412. **Vanilla + TypePad Connect Commenting** 
     95    * Sample implementation of TypePad Connect Commenting. 
     96    * Abstracting Configuration into Module 
     97    * Option for integrating MT and TP comments 
    9598 
    9699 
    97 ## INSTALLATION ## 
     100### Download 
    98101 
    99     Place the Vanilla plugin folder in the MT plugins folder 
     102* [Vanila beta 2](Vanilla_b2.zip) - 2008 Nov 21 
     103* [Vanila beta 1](Vanilla_b1.zip) - 2008 Sep 4 
    100104 
    101         $MT_DIR/ 
    102             plugins/ 
    103                 Vanilla 
     105### Installation 
    104106 
    105 ## USAGE ## 
     107    $MT_DIR/ 
     108        plugins/ 
     109            Vanilla/ 
    106110 
    107     Install template sets in two ways: 
     111## Known Issues 
    108112 
    109     1. When creating a new blog, select the template set you wish to use 
    110     2. Go to Design > Templates and select the "Refresh Templates" action link in the sidebar and choose the template set you wish to install 
     113Any issues with each template set are listed under each template set in the Features section above. 
    111114 
    112 ## KNOWN ISSUES ## 
     115## Support 
    113116 
    114     Any issues with each template set are listed under each template set in the Features section above. 
     117There is no official support for this plugin, but you may email beau at sixapart com and/or mtos-dev@sixapart.com for assistance. 
    115118 
    116 ## SUPPORT ## 
     119## Bugs 
    117120 
    118     There is no official support for this plugin, but you may email <beau at sixapart com> and/or mtos-dev@sixapart.com for assistance. 
     121Please email beau at sixapart com. 
    119122 
    120 ## SOURCE CODE ## 
     123### Code 
    121124 
    122     Source 
     125* **Subversion** [http://code.sixapart.com/svn/mtplugins/trunk/Vanilla/](http://code.sixapart.com/svn/mtplugins/trunk/Vanilla/) 
     126* **TRAC** [Code Browser](http://code.sixapart.com/trac/mtplugins/browser/trunk/Vanilla) [Revision Log](http://code.sixapart.com/trac/mtplugins/log/trunk/Vanilla) 
    123127 
    124     SVN Repo: 
    125     http://code.sixapart.com/svn/mtplugins/trunk/Vanilla 
     128### Revision History 
    126129 
    127     Trac View: 
    128     http://code.sixapart.com/trac/mtplugins/browser/trunk/Vanilla 
     130<dl> 
     131    <dt>b3 - 2009 Jun 05</dt> 
     132    <dd>Beta 3 Release: Typo in yaml. Updates to readme.</dd> 
     133    <dt>b2 - 2008 Nov 21</dt> 
     134    <dd>Beta 2 Release: Widgets, Scoring, TypePad Connect</dd> 
     135    <dt>b1 - 2008 Sep 04</dt> 
     136    <dd>Beta 1 Release</dd> 
     137</dl> 
    129138 
    130     Plugins: 
    131     http://plugins.movabletype.org/Vanilla (Not Yet Available) 
    132  
    133  
    134 ## LICENSE ## 
    135  
    136     GPL 
    137  
    138 ## AUTHOR ## 
    139  
    140     Beau Smith <beau at sixapart com> http://beausmith.com/ 
     139### Developers 
     140* [Beau Smith](http://beausmith.com) at [Six Apart](http://www.sixapart.com)