ftw.candlestick
Project description
Introduction
The name candlestick comes from the early times when the telephone has been invented. One of the first model of a telephone was a stick which has been placed on table where the speaker had to talk into.
This module provides a javascript library for automatically generate phone links.
A treeWalker walks through the whole DOM and collects all textNodes
. If a node
matches a phone number the number will be replaced with a <a href="tel:phonenumber">Your phonenumber</a>
link. Existing links or inputfields are not affected.
By default the candlestick.integration.js is being loaded which converts all phone numbers in the body initially.
Compatibility
Plone 4.3.x
Installation
Add the package to your buildout configuration:
[instance]
eggs +=
...
ftw.candlestick
Development
Python:
Fork this repo
Clone your fork
Shell: ln -s development.cfg buidlout.cfg
Shell: python boostrap.py
Shell: bin/buildout
Or start an instance by running bin/instance fg.
Links
Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.candlestick
Copyright
This package is copyright by 4teamwork.
ftw.candlestick is licensed under GNU General Public License, version 2.
Client library
Getting Started
The client library depends on Grunt. Assuming you already have Node.js installed on your system, run the following command:
sudo npm install -g grunt
To install the dependencies, run the following command:
npm install
And with npm you get the following packages:
Usage
Run the following command to re-build the library:
grunt build
Run the following command to watch for changes which trigger a rebuild:
grunt
Build options
See https://github.com/substack/browserify-handbook for more information about browserify.
Source Maps
Browserify comes with a built-in support to generate source maps. It is already enabled by default, but feel free to disable source maps. Refer to this article to enable source maps in Google Chrome, if you haven’t already done so.
Tests
Run all tests
grunt test
Run a specific test
grunt test --grep="Name of your test"
Initialization
Converts all phone numbers to links
window.candlestick();
Changelog
1.1.0 (2019-09-04)
Test against Plone 5.1.x. [mbaechtold]
Add HISTORY.txt to long description. [busykoala]
1.0.5 (2018-01-11)
Compile javascript sources. [Kevin Bieri]
1.0.4 (2017-12-13)
IBAN number are no longer recognized as phone numbers. [Kevin Bieri]
1.0.3 (2017-03-23)
Fix parson of phonenumbers.
No longer allow too short phonenumbers
Allow phone numbers with varying spaces around number groups
[Kevin Bieri]
Move phonenumbers samples to testing section. [Kevin Bieri]
Fix readme. [Kevin Bieri]
1.0.2 (2017-03-10)
Fix parse and replace issues.
Parentheses should not be included in the phone links.
Trailing text should not be ignored.
[Kevin Bieri]
1.0.1 (2017-01-13)
Fix error in treeWalker on Internet Explorer >= 9. [Kevin Bieri]
1.0.0 (2016-11-30)
Initial implementation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.