Skip to content
Violet edited this page Dec 6, 2010 · 2 revisions

Melody Registry Config.yaml Cheat Sheet

Here's a quick reference for some of the choices available in defining items in the Melody registry via the config.yaml. For more complete tutorials on the config.yaml, see the Melody Theme Designer Guide and the Melody Developer Guide.

  id: MySuperTheme                                                 required - complete with your choice
  name: "My Super Theme"                                           required - complete with your choice
  description: "A demo theme from the documentation."              required - complete with your choice 
  author_name: Your Name                                           required - complete with your choice
  author_link: http://www.yourwebsite.com/                         recommended - complete with your choice
  version: 1.0                                                     required - complete with your choice

Terms used in defining a theme. See the Melody Theme Designer Guide for more complete instructions.

  template_sets:                                                required
    my_super_theme:                                             required - complete with your choice
      label: "Blog Theme (My Super Theme)"                      required - complete with your choice
      base_path: templates                                      required - complete with your choice
      templates:                                                required
        index:                                                  required   
          main_index:                                           required - complete with your choice
            label: "Main Index"                                 recommended - complete with your choice
            outfile: "index.html"                               recommended - complete with your choice
            build_type: 1                                       optional - 1 = publish on demand; see MTDG: Build Types for other values
        individual:                                             required
          article:                                              required - complete with your choice 
            label: 'Article'                                    recommended - complete with your choice; will default to template name `article` if not specified
            mappings:                                           required - complete with your choice
              individual:                                       required
                archive_type: Individual                        required - choices for Individual archive: 'Individual' for use with entries, 'Page' for use with pages  
                file_template: %y/%m/%-f                        required - complete with your choice of archive file path specifiers
                preferred: 1                                    optional - identifies the preferred archive mapping permalink; use is recommended when multiple archive mappings are generated for a given entry.  See MTDG: Index and Archive Templates for more detail.
        archive:                                                recommended  - See MTDG: Index and Archive Templates for more detail
          entry_listing:                                        required - complete with your choice 
            label: 'Entry Listing'                              recommended - complete with your choice; will default to template name `entry listing` if not specified
            mappings:                                           required - complete with your choice
              by-category:                                      recommended
                archive_type: Category                          required    
              by-month:                                         recommended
                archive_type: Monthly                           required    

Links: MTDG: Build Types, MTDG: Index and Archive Templates, Archive file path specifiers

You can also use the config.yaml to set blog preferences as part of your theme. Below are the choices from the Classic Blog Theme Pack by Dan Wolfgang begin_of_the_skype_highlighting     end_of_the_skype_highlighting.

id: ClassicBlogThemePack  
key: ClassicBlogThemePack
name: 'Classic Blog Theme Pack'  
description: '“Classic Blog” was the original template set included with Movable Type 4.0. This Theme Pack combines the various styles available for the Classic Blog template set, and completely removes the need for the StyleCatcher.'
author_name: 'Dan Wolfgang, uiNNOVATIONS'
author_link: 'http://uinnovations.com'
version: 1.0.5
static_version: 4
template_sets:
  classic_blog_minimalist:
    .
    .
    .
blog_preferences:
  classic_blog_preferences:
    label: 'Classic Blog Preferences'
    description: 'Preferred preferences for the Classic Blog Theme Pack'
    plugin_data:
      ActionStreams:
        rebuild_for_action_stream_events: 1
    preferences:
      allow_anon_comments: 1
      allow_comment_html: 1
      allow_commenter_regist: 1
      allow_comments_default: 1
      allow_pings: 1
      allow_pings_default: 1
      allow_reg_comments: 1
      allow_unreg_comments: 1
      #archive_type: 
      archive_type_preferred: entry
      autodiscover_links: 0
      autolink_urls: 1
      basename_limit: 100
      captcha_provider: 
      cc_license: 
      commenter_authenticators: MovableType
      convert_paras: 'Markdown with Smartypants'
      convert_paras_comments: 1
      custom_dynamic_templates: none
      days_on_index: 0
      email_new_comments: 1
      email_new_pings: 1
      entries_on_index: 10
      file_extension: html
      follow_auth_links: 1
      image_default_align: right
      image_default_constrain: 1
      image_default_thumb: 1
      image_default_width: 150
      #image_default_popup: 0
      #image_default_wrap_text: 
      #image_default_wunits: 
      include_cache: 1
      include_system: 0
      internal_autodiscovery: 0
      is_dynamic: 0
      junk_folder_expiry: 7
      junk_score_threshold: 0
      #language: 
      manual_approve_commenters: 0
      moderate_pings: 1
      moderate_unreg_comments: 0
      nofollow_urls: 0
      #nwc_smart_replace: 
      #nwc_replace_field: 
      #ping_blogs: 
      #ping_google: 
      ping_others: http://rpc.pingomatic.com
      #ping_technorati: 
      #ping_weblogs: 
      #remote_auth_token: 
      require_comment_emails: 1
      require_typekey_emails: 0
      #sanitize_spec: 
      #server_offset: 
      sort_order_comments: ascend
      sort_order_posts: descend
      status_default: 2
      #update_pings: 
      use_comment_confirmation: 1
      #welcome_msg: 
      words_in_excerpt: 40

Those preferences that are preceded by a '#' are regarded as comments in YAML syntax.

 


Questions, comments, can't find something? Let us know at our community outpost on Get Satisfaction.

Credits

  • Author: Violet Bliss Dietz
  • Edited by:
Clone this wiki locally