root/trunk/Vanilla/README.txt @ 1553

Revision 1553, 5.2 kB (checked in by bsmith, 6 months ago)

updating readme

  • Property svn:eol-style set to native
RevLine 
[920]1## Vanila, a plugin for Movable Type
[1553]2## Author: Beau Smith at Six Apart
[920]3## Version: 0.1
4## Released under GPL
[675]5
[1553]6## Overview
[675]7
[1553]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.
[675]9
[1553]10### Prerequisites
[675]11
[1553]12* **Movable Type 4.2** for most features
13* **Score Plugin** for Vanilla + Scoring template set
[675]14
[1553]15### Usage
[675]16
[1553]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
[675]24
[1553]25### Tips
[920]26
[1553]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_
[920]28
[1553]29### Templates Sets
[920]30
[1553]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)
[920]87
[1553]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/).
[920]89
[1553]90    Tip: to remove all scoring for a particular namespace, use this SQL command:
[920]91
[1553]92        delete from mt_objectscore where objectscore_namespace = 'NAMESPACE';
[920]93
[1553]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
[929]98
[1220]99
[1553]100### Download
[1255]101
[1553]102* [Vanila beta 2](Vanilla_b2.zip) - 2008 Nov 21
103* [Vanila beta 1](Vanilla_b1.zip) - 2008 Sep 4
[1255]104
[1553]105### Installation
[1255]106
[1553]107    $MT_DIR/
108        plugins/
109            Vanilla/
[675]110
[1553]111## Known Issues
[675]112
[1553]113Any issues with each template set are listed under each template set in the Features section above.
[675]114
[1553]115## Support
[675]116
[1553]117There is no official support for this plugin, but you may email beau at sixapart com and/or mtos-dev@sixapart.com for assistance.
[675]118
[1553]119## Bugs
[920]120
[1553]121Please email beau at sixapart com.
[675]122
[1553]123### Code
[675]124
[1553]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)
[675]127
[1553]128### Revision History
[675]129
[1553]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>
[675]138
[1553]139### Developers
140* [Beau Smith](http://beausmith.com) at [Six Apart](http://www.sixapart.com)
Note: See TracBrowser for help on using the browser.