bbc/scribe-plugin-bidi

Name: scribe-plugin-bidi

Owner: BBC

Description: Add bidirectional markup to https://github.com/guardian/scribe

Created: 2016-09-09 09:20:30.0

Updated: 2016-09-15 08:03:57.0

Pushed: 2016-09-21 15:38:15.0

Homepage:

Size: 170

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

scribe-plugin-bidi

A scribe plugin for adding bidirectional markup. Allows users to tightly wrap opposite-direction phrases to correct the Unicode Bidirectional Algorithm when it goes wrong.

Adds scribe commands ltr-bidi which surround a text selection with <span dir="ltr"></span>.

See also:

• Unicode Bidirectional Algorithm Basics
• Examples for correct markup of opposite-direction phrases

Installation

r install scribe-plugin-bidi

scribe-plugin-bidi is an AMD module:

ire(['scribe', 'scribe-plugin-bidi', 'scribe-plugin-bidi-sanitize'], function (Scribe, plugin, sanitize) {
r scribeElement = document.querySelector('.scribe');
r scribe = new Scribe(scribeElement);
ribe.use(plugin());
ribe.use(sanitize());

Running Tests

To setup the environment, scribe-test-harness requires:

1. Usage of node v0.12.7 (newer versions will fail because execsync was removed from Node)

2. Adding chromedriver executable to your $PATH.

   wnload chromedriver executable from website
   dir ~/Documents/Executables
    chromedriver ~/Documents/Executables
   =$PATH:~/Documents/Executables
   

3. Downloading dependencies (including selenium webdriver) via npm run setup

To run the tests:

run test

License

MIT License.
Copyright © 2016 British Broadcasting Corporation