Skip to content

Latest commit

 

History

History
82 lines (39 loc) · 3.61 KB

README.textile

File metadata and controls

82 lines (39 loc) · 3.61 KB
Raw

spf_js

JavaScript management plugin for Textpattern.

Create, edit and delete scripts in Textpattern admin and export on save to external files.

REQUIRES: Texpattern 4.4.1 and PHP 5.

Please read the instructions and notes below before use.

A combination of two previously-released plugins: stm_javascript by Stanislav Müller and rvm_css by Ruud van Melick. Thanks to the original authors and to Jukka (Gocom) and Stef (Bloke) for invaluable feedback.

Features include exporting scripts as files to a directory, optional “type” attribute type="text/javascript" and changing the tag argument from n= to name= to bring it in line with default css syntax.

Re-written for Textpattern 4.4.1 to mimic the Presentation > Style tab.

DOWNLOAD

Instructions:

  1. Create a directory for the static JavaScript files in the root of your textpattern installation. You should make sure that PHP is able to write to that directory.
  2. Visit the Advanced Preferences (Admin > Preferences > Advanced) and make sure the “JavaScript directory” preference contains the directory you created in step 1 (by default ‘js’). This path is relative path to the directory of your root Textpattern installation.
  3. Activate this plugin.
  4. Go to Presentation > JavaScript and create JavaScripts you’d like to embed within your page templates.
  5. JavaScript files are stored in the database (for easy management and editing) and, on save, exported to a directory in your website where they can be referenced (as external JavaScript) with the tag below.

Tags:

<txp:spf_js /> (embeds the default JavaScript file)

<txp:spf_js name="myscript" /> (embeds the JavaScript file named "myscript")

HTML output:

<script src="http://mysite.com/js/myscript.js"></script>

“type” attribute

By default the plugin outputs a script tag without the ""type" attribute":http://www.w3schools.com/html5/tag_script.asp (required in XHTML/HTML4 but optional in HTML5).

To include a “type” attribute just use the type="1" argument:

<txp:spf_js name="myscript" type="1" />

Outputs:

<script type="text/javascript" src="http://mysite.com/js/myscript.js"></script>

Notes:

  1. Don’t use non-alphanumeric characters in script names (if you try to they’ll be stripped).
  2. The plugin will convert your script names to lowercase.
  3. The plugin will throw an error if you try to embed a non-existent script – similar to: Tag error: -> Textpattern Notice: The requested resource was not found. "script_name".

— In which case check the script exists and your embed tag for typos.

stm_javascript

If stm_javascript is installed and activated you will see two JavaScript tabs in Presentation – one named ‘Javascript’ (stm_javascript – with lowercase ‘s’) and another ‘JavaScript’ (spf_js – uppercase ‘S’). You can copy and paste scripts from stm_javascript to spf_js – and then disable stm_javascript. It’s not advisable to run both plugins simultaneously.

Language support (Textpack)

This plugin uses an English Textpack by default and installs both French (fr-fr) and German (de-de) Textpacks.

To use your own language see the spf_js_textpack file in this repository.

Version history

  • 0.2 – April 2012 * French & German Textpacks added (thanks Patrick & Uli); * added compatibility with the syntax-highlighting spf_codemirror.
  • 0.1 – April 2012 * first release.