Skip to content

themojinator/RWThemeKit

 
 

Repository files navigation

#RapidWeaver Theme SDK v6.0 This is preliminary information, and subject to change prior to the launch of RapidWeaver 6

This README describes solely the changes to the RWThemeKit SDK for RapidWeaver v6. For full reference, please refer to the documentation contained in this repository.

##Deprecations

Starting in RapidWeaver 6, the %toolbar% key is considered deprecated. Instead, developers should move to use %navigation%. %navigation% displays the same data as %toolbar% would previously.

The RWThemeAuthor key is deprecated, and you should use RWAddonAuthor for your Developer Name.

##Behaviour Change

To account for the new design of the Theme Variations window, RapidWeaver 6 will assume a Theme Variation Group Selection Limit of 0 if one has not been specified in the theme. All themes must specific a theme variation group selection limit.

##New Additions RapidWeaver 6 introduces the ability for themes to offer split navigation.

%top_navigation% returns an unordered list of just the top-level of the page hierarchy. %sub_navigation% returns an unordered list of the remaining sub-navigation of the hierarchy, and respects the RWAlwaysDisplayFullNavigation key.

The RWToolbarItem Theme PLIST keys now offer a new “Parent” variation that allows you to specify the markup for the navigation menu when the page has subpages (i.e. is a parent page). For examples, check this commit.

The new RWAddonManagerIconAsset Theme.plist key should include the name of a 128 x 128 pixel image to display in the RapidWeaver 6 Addon Manager. You should include this image @2x and end the image name @2x so that it appears on retina displays. The @2x variant does not need to be specified in the Theme.plist.

##Targeting RapidWeaver 6 As the new %navigation% tags are only available in RapidWeaver 6, to ensure that themes are only installed in versions of RapidWeaver that support this feature, RapidWeaver supports the .rapidweavertheme file extension in addition to the legacy .rwtheme extension.

We strongly encourage themes to use the latest RapidWeaver Theme SDK conventions and features, and whilst RapidWeaver 6.x will support .rwtheme files this file format should be considered deprecated and may be removed in the longer term.

##Installing & Organising Themes RapidWeaver 6 stores themes within the Themes sub-folder of the RapidWeaver 6 App Support. Themes from RapidWeaver 5 can be copied from RapidWeaver 5 during the first-run of RapidWeaver 6. They are copied to the Themes sub-folder, and any organisation folders from RW5 or earlier will be preserved as Collections in the new Addons Manager.

About

The RapidWeaver Theme SDK

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published