Changeset 819

Show
Ignore:
Timestamp:
07/09/08 20:25:43 (17 months ago)
Author:
bsmith
Message:

todo moved to README

Location:
trunk/Sandbox
Files:
1 removed
1 modified

Legend:

Unmodified
Added
Removed
  • trunk/Sandbox/README.txt

    r745 r819  
    11## MTSandboxTemplateSet, a plugin for Movable Type 
    2 ## Author: Beau Smith  <beau@sixapart.com> http://sixapart.com 
    3 ## Author: Bryan Tighe <btighe@sixapart.com>  http://sixapart.com 
     2## Author:  Beau Smith <beau@sixapart.com> 
     3## Author:  Bryan Tighe <btighe@sixapart.com> 
    44## Version: 1.0 
    5 ## Released under GPL 
     5## License: GNU General Public License 
    66 
    77## OVERVIEW ## 
    88 
    9     This plugin provides a new template set based upon The Sandbox theme developed by Scott Allan Wallick of PlainTxt.org 
     9This plugin provides a new template set based upon The Sandbox theme developed by Scott Allan Wallick of PlainTxt.org 
     10 
    1011 
    1112## PREREQUISITES ## 
    1213 
    13     * MT 4.2 or greater 
     14* MT 4.2 or greater, but will work with all 4.x versions if javascript template is modified. 
     15* Ability to publish PHP files 
     16 
    1417 
    1518## FEATURES ## 
    1619 
    17     * Semantic HTML markup 
    18     * library of available themes 
     20* Best described on the PlainTxt site: http://www.plaintxt.org/themes/sandbox/ 
     21* Library of available themes: http://sndbx.org/results/designs/ 
     22 
    1923 
    2024## INSTALLATION ## 
    2125 
    22     MT_DIR/ 
     26MT_DIR/ 
     27    plugins/ 
     28        SandboxTemplateSet 
     29    mt-static/ 
    2330        plugins/ 
    24             SandboxTemplateSet 
    25         mt-static/ 
    26             plugins/ 
    27                 SandboxTempalteSet 
     31            SandboxTempalteSet 
    2832 
    29 ## CONFIGURATION ## 
    30  
    31     * No Configuration Options 
    3233 
    3334## USAGE ## 
    3435 
     36* Creating New Blog 
     37    1. Under Template Set, choose "Sandbox" 
     38    2. Create an entry 
     39    3. View your site 
    3540 
    36     * Creating New Blog 
    37         1. Under Template Set, choose "Sandbox" 
    38         2. Create an entry 
    39         3. View your site 
     41* Updating Existing Blog 
     42    1. Go to Design > Templates. 
     43    2. Click "Refresh Blog Templates" in the Actions sidebar widget. 
     44    3. In the modal that appears, choose "Apply new template set" and then choose "Sandbox" from the select menu of template sets. Optionally choose to "Make backups of existing templates" 
     45    4. Click "Continue", then "Confirm" 
     46    5. Republish your blog 
     47    6. View your site 
    4048 
    41     * Updating Existing Blog 
    42         1. Go to Design > Templates. 
    43         2. Click "Refresh Blog Templates" in the Actions sidebar widget. 
    44         3. In the modal that appears, choose "Apply new template set" and then choose "Sandbox" from the select menu of template sets. Optionally choose to "Make backups of existing templates" 
    45         4. Click "Continue", then "Confirm" 
    46         5. Republish your blog 
    47         6. View your site 
    48      
     49* Switching Themes 
     50    1. Open the styles.css index template. 
     51    2. Comment out the currently enabled theme. 
     52    3. Uncomment the desired theme. 
    4953 
    50 ## KNOWN ISSUES ## 
     54* Installing New themes 
     55    1. Place the theme folder in $MT_DIR/plugins/Sandbox/themes/. 
     56    2. Add a link to the stylesheet of the new theme in the styles.css index template. 
    5157 
    52     * When creating a folder you must create a page with a basename of "index" in that folder in order for the navigaiotn to function correctly. Wordpress does not have the concept of folders, thus this is a two-step process in Movable Type. 
     58 
     59## KNOWN ISSUES & DIFFERENCES FROM WP PLUGIN ## 
     60 
     61* When creating a folder you must create a page with a basename of "index" in that folder in order for the navigaiotn to function correctly. Wordpress does not have the concept of folders, thus this is a two-step process in Movable Type. 
     62* Sidebar is not created using WidgetManager. This was left out for simplicity, but may be incorporated in a future version. 
     63 
     64    ### Addtions to Sandbox HTML in Movable Type ### 
     65    * comment dates are wrapped in abbr tag with iso8601 date 
     66    * because comments and trackback are different object types the id for individual TrackBacks is "trackback-ID#" instead of "comment-ID#" 
     67    * comment-meta added to trackbacks to be more similar to comment markup 
     68    * added class "trackback-title" to <p> containing the title of the TrackBack 
     69    * Captcha for un-authenticated comments (class .comment-captcha) 
     70    * Added rel next and prev category links to html head 
     71    * Additional archive types are available: author-date-based and category-date-based entry listings. 
     72    * (there may be a few additional differences which were overlooked) 
     73 
     74    ### Differences in Sandbox on Movable Type vs. WordPress ### 
     75    * MT doesn't support password protected posts/entries because it is not dynamic. 
     76    * Edit link placed at the end of entry-meta data for consistency. 
     77    * <$mt:EntryBody$> and <$mt:EntryMore$> are both included in the entry detail 
     78    * unauthenticated commenters info is baked into cookie by default to mimic WP behaviour 
     79    * Links (or Blogroll) is not a core feature of MT, but a page or plugin may be used to provide this functionality. 
     80    * The archive page in MT is an index template and doesn't require the use of a page template as in WP. The markup has been preserved such that all themes will still apply correct markup. 
     81    * MT doesn't have the ability to remove the current category when viewing an entry on a category index page. A feature request for this has been submitted to Six Apart: http://bugs.movabletype.org/default.asp?80604 
     82    * Added hAtom for author name on Author archives 
     83    * No "description" field to author profile for use on the Author Archives, this can be added via CustomFields 
     84 
     85 
     86## TO DO LIST ## 
     87 
     88* Convert config to YAML 
     89    * http://code.sixapart.com/svn/mtplugins/trunk/ConfigAssistant/ 
     90    * http://svn.sixapart.com/repos/eng/mtplugins/branches/PremiumNews/ 
     91* Ensure php functions work like functions in perl plugin script 
     92* Add entry atom feed including comments 
     93* Condition edit links to only display when user is logged into app (php/cookie) 
     94* Move sidebar elements into WigetManager 
     95* Document how to add comments on pages 
     96* Document tags: 
     97    * <$mt:SandboxBodyClass$> 
     98    * <$mt:SandboxEntryClass$> 
     99    * <$mt:SandboxPageClass$> 
     100    * <$mt:SandboxCommentClass$> 
     101    * <$mt:SandboxTrackbackClass$> 
     102    * <mt:IfFeedbackEnabled> 
     103 
     104 
     105## SOURCE CODE ## 
     106 
     107Plugin Home     http://beausmith.com/mt/plugins/sandbox 
     108MT Plugins Repo http://plugins.movabletype.org/Sandbox 
     109SVN Repo        http://code.sixapart.com/svn/mtplugins/trunk/Sandbox 
     110Trac Browser    http://code.sixapart.com/trac/mtplugins/browser/trunk/Sandbox 
     111 
    53112 
    54113## SUPPORT ## 
    55114 
    56     * There is no official suppor for this theme from the developers. But a nice email with a promise of fresh-baked cookies may get you special assistance. 
    57  
    58 ## SOURCE CODE ## 
    59  
    60     Developer Home 
    61         http://beausmith.com/mt/plugins/sandbox 
    62  
    63     Plugins: 
    64         http://plugins.movabletype.org/Sandbox 
    65  
    66     SVN Repo: 
    67         http://code.sixapart.com/svn/mtplugins/trunk/Sandbox 
    68  
    69     Trac View: 
    70         http://code.sixapart.com/trac/mtplugins/browser/trunk/Sandbox 
    71  
    72  
    73 ## LICENSE ## 
    74  
    75     * GPL -  
    76  
    77 ## AUTHOR ## 
    78  
    79     * Beau Smith  <beau@sixapart.com> http://sixapart.com 
    80     * Bryan Tighe <btighe@sixapart.com>  http://sixapart.com 
     115* A email sent with promisew of fresh-baked cookies may get you special assistance, but there is not dedicated support for this template set. 
     116* Post your questions to the Movable Type Forums:  
     117    * http://forums.movabletype.org/ 
     118    * http://forums.movabletype.org/2008/07/sandbox.html