0 Style Developers: Migrating to 2.1.1

emsquared edited this page 2013-03-02 00:17:05 -08:00

Unescape Escape

Table of Contents

• CSS Changes
• Folder Structure
• Template Engine

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Version 2.1.1 of Textual changes several aspects of how custom styles are handled. These changes include a new folder layout as well as a changes to the CSS that a style is delegated to handle.

CSS Changes

The following type values supported by the "body div.line" element have been removed:

reply, error, system, debug_send, error_reply, debug_receive

They have been replaced by:

debug, rawhtml

Folder Structure

The following folder structure is the one recommend for use in version 2.1.1.

 – copyright.txt
 – Data
    \ – Resources (Custom resources: images, fonts, etc.)
    \ – Documentation (Version information, changes, etc.)
    \ – Templates (Custom templates.)
    \ – Settings
         \ – styleSettings.plist
         \ - styleLocalizations.plist
 – design.css
 – scripts.js

The files preferencesOverride.plist and userInterface.plist have been merged into a single file named styleSettings.plist. The file BasicLanguage.plist has been renamed to styleLocalizations.plist and must be placed within the "Settings" folder of a style.

Template Engine

2.1.1 supports a brand new template engine which means a style can edit any part of the HTML rendered by Textual. These templates are opt-in. A style developer does not need to use any of them.

The default templates used by Textual can be found in the folder Textual.app –> Contents –> Resources –> Style Default Templates – copying the contents of this folder into a styles "Templates" folder will allow that style to override the HTML.

Templates are Mustache based.