Software

Overview

This add-on will implement pirate speak on your site in one of three ways:

• By changing page content entirely
• By using template tags to modify a block of content on a page
• By changing the format of a field’s output

These instructions may be a little harder to read on Talk Like a Pirate Day, when the whole Hop Website is in Pirate Speak. Sorry, matey!

Installation

1. Unzip the folder to a temporary location on your local hard drive.
2. FTP the files from their local folders to the same locations in your EE install’s /system/user/addons/ folder on the server.
3. Navigate to Add-ons in your EE control panel and install the add-on. That’s it!

Settings / Site-Wide Change

In the Settings for Hop Privateer, you can choose to change your entire site at once.

Be aware that page caching may affect who sees which type of output and the timing of when it appears. The add-on makes no attempt to change or clear caching, and leaves that up to you.

The values in settings can be overridden by the template tag.

Apply to Entire Site?

Set “Apply to Entire Site?” to on, and all of your content on all of your public pages will be changed.

Hop PrivatEEr does a good job of avoiding messing with HTML, but we recommend testing before you turn it loose on your whole site..

All pages are affected – think about AJAX and RSS and such.

When Should Hop PrivatEEr Be Active?

Here you can set the defaults for when Hop PrivatEEr activates. Your choices are:

• On Sept. 19, Talk Like a Pirate Day
• Always
• Never

When Never is chosen, you can still use the template tag with a different value. To disable the add-on entirely, you must uninstall it.

Who Sees the Translated Text?

You can choose who sees the Pirate-d version of the output:

• Everyone
• Any Logged In User
• Super Admins

Super Admins is useful for testing.

Template Tag

By using the {exp:hop_privateer} tag pair, you can implement pirate speak on only some pages or in some content.

{exp:hop_privateer when="pirateday" who="everyone"}
Hello, coworkers.
{/exp:hop_privateer}

This will output: Ahoy, shipmates.

Parameters

These parameters will override the add-on settings set in the control panel.

when="always"
when="never"
when="pirateday"

When set to “always”, all the content inside the tag pair will always be changed.

When set to “pirateday”, the content inside the tag pair will only be changed on Sept. 19.

Note, however, that setting this parameter to “never” will not protect content from being changed site-wide, if that is happening because of the add-on’s overall settings.

In other words, if the add-on is set to “always” AND is set to change all site content, you cannot block that with this tag. But if the add-on is set to “always” but is NOT set to change all site content, then setting THIS tag parameter to “never” will stop this tag from doing its conversion.

who="everyone"
who="any_loggedin_user"
who="super_admins"

This overrides what is specified in the add-on settings.

Conditional

{if is_pirate_day}

This is true on Sept. 19, and false the rest of the year. It can be useful to let you to display a flag, change colors, or do anything else you want to do along with translating content.

Text Format

When installed, Hop PrivatEEr will automatically appear as an additional text formating option for any text field. This means you can have a field that you enter as regular text and it will output in Pirate Speak.

The field output will respect the when and who settings in the settings page. If you want a field to always output Pirate Speak, you need to set the add-on settings to “always.”

This may be easier than always wrapping the text field in an {exp:hop_privateer} tag.

Examples

Wrapped in Tags

{exp:hop_privateer}
    Give me and my friends some money.<br>
    {if is_pirate_day}
        <p>Yes, it is Talk Like a Pirate day!</p>
        <img src="https://hopstudios.com/images/uploads/PrivatEE2.png" style="max-width: 100%;">
    {/if}
{/exp:hop_privateer}

Output:

Give me an’ me mates some doubloons. yes it be gentleman o’ fortune day!

Channel Field with Hop PrivatEEr Formatting

{exp:channel:entries channel="channel_with_that_field"}
    <h2>{title}</h2>
    <p>{hop_privateer_text_box}</p>
{/exp:channel:entries}

Updating

Updating is easy:

1. Download a new version from this website, and extract on your hard drive.
2. Upload the new files to their appropriate locations.

Uninstalling

1. Navigate to the Add-Ons > Modules tab in your EE control panel and uninstall the module.
2. Remove the add-on directory from your EE system folder on the server.