PlusKit Reference Guide

Installation

To install the PlusKit plugin:

• Download PlusKit from our website.
• Double click the PlusKit.rapidweaverplugin file.
• If RapidWeaver is running, restart.

PlusKit is now installed ready to use.

Getting Started

To get started, add a PlusKit page to your RapidWeaver document by choosing Add Page in RapidWeaver and selecting PlusKit.

Styled Text Plus

Using the syntax <markdown> text </markdown> allows you to use markdown in any Styled Text area. 

Here is a reference for markdown syntax.

Image Effects

PlusKit provide three image effects that you can use on in-line images in your styled text: Lightbox, Fancy Zoom, and Fancy Box.

Automatic Lightbox

Check the "Enabled Automatic Lightbox" to have the option of having a lightbox (zoom) effect on your in-line pictures. Once you've checked the box, click the "Lightbox Triggers" button to specify conditions that determine which pictures will have the lightbox effect.

PlusKit will search for all images with properties that you specify. See below for more about the search criteria.

Automatic Fancy Zoom

Check the "Enabled Automatic Fancy Zoom" to have the option of having a Fancy Zoom effect on your in-line pictures. Fancy Zoom is from Panic. PlusKit provides an easy way to incorporate it into your RapidWeaver site. Once you've checked the box, click the "Fancy Zoom Triggers" button to specify conditions that determine which pictures will have the Fancy Zoom effect.

PlusKit will search for all images with properties that you specify. See below for more about the search criteria.

Note: Fancy Zoom is only for noncommercial use. If you want to use it on a commercial site, click the button to purchase a license from Panic.

Automatic Fancy Box

Check the "Enabled Automatic Fancy Box" to have the option of having a Fancy Box effect on your in-line pictures. Once you've checked the box, click the "Fancy Box Triggers" button to specify conditions that determine which pictures will have the Fancy Box effect.

PlusKit will search for all images with properties that you specify. See below for more about the search criteria.

Search Criteria

If you specify more than one main criteria, you can then choose whether to match ALL or ANY of the criteria.

Importing

PlusKit lets you pull the contents of one page into another. 

This is a pro-level tool. Although you can combine some pages that work great together, PlusKit also allows you to combine pages that don't work great together. Most of the time, if you've followed all the requirements and the import is not working, then it simply won't work.

You need to have at least two pages in your RapidWeaver document: the source page and the destination page. In a text area on the destination page, type the following

@import((source_page_name))

where “source_page_name” is the name of the page that you are importing.

Once you’ve entered that text, when you preview the destination page, you should see the source page inserted.

Google Integration

This feature allows you to

• edit remote Google docs or spreadsheets and have the contents update in realtime.
• include dynamic content in your RapidWeaver site that come directly from Google spreadsheets.

To use these features, in a styled text area on the destination page, type the appropriate command: @gdoc((key)) or @gtable((key)).

where “key” is the key of the page that you are importing. Here’s how to find the key.

1. Open the Google doc or spreadsheet that you want to include in your site.
2. From the File menu, choose “Publish to the web”.
3. In the window that appears, click Publish, then OK.
4. Copy the Google doc key from the “Publish to the web" window (see below) to inside the parentheses of the gdoc((key)) command.

A link to your Google doc appears that looks something like

https://docs.google.com/document/d/1wPlbk8Gs1aKVfNEUW2P6CpreKjZJI8HW_jXXik3ra0/pub

The key is the alpha-numeric section that is after "d/" and before "/pub" in the example above. Each document has a unique key.

Additional Requirements

• Web host that supports PHP
• Filename must end in .php — in RapidWeaver, check the Inspector for the page where you have the @gdoc((key)) command.
• Google doc must be set to Automatically Republish — in the “Publish to the web” window, check the “Published content & settings” section.
• Clear the formatting of @gdoc((key)) line of text — select the text and choose “Clear Formatting” from the Format menu in RapidWeaver.

 Gtable Syntax

After each syntax name that you use, include a colon before the values. Do not use spaces. If an argument takes multiple values (such as the ignore argument), separate the multiple values by semicolons.

After the values, include a comma before the next syntax name.

 

Gtable Themes

The following are names of themes that you can use for your imported spreadsheet. You can test them out in preview to view how they look with your site theme.