tail.writer0.4.0 • Public • Published
- Compatible with all modern browsers, and also for IE >= 9.
- WriteFlow supportive Features & Functions
- A Translation API to use your websites-native language
- An extensive Markup API to use custom Markup languages and actions
- Hooks, Event Listeners & Key-Bindings for your own code
- No dependencies, just include and use it (except the Preview-Action)!
- Bindings for the jQuery and MooTools library and usable as AMD.
- 3 beautiful Designs and many settings!
WYSIWYG vs. Markup
The tail.writer script is not a WYSIWYG (What you see is what you get) editor, it's a Markup editor. The difference is the presentation of the written text: A WYSIWYG editor shows a bold text directly as bold text, while a Markup editor shows only the Markup syntax: **bold text**. (The shown syntax depends on the used Markup language, of course!)
You can also use your own (or a not supported) parser library, of course. Check out the option
which allows you to pass your own parser callback function !
Install & Embed
The master branch will always contain the latest Version (incl. not-released updates), which you can download directly here as .tar or as .zip archive, or just visit the Releases Page on GitHub directly. You can also be cool and using npm, Yarn or bower:
npm install tail.writer --save
yarn add tail.writer --save
bower install tail.writer --save
Using a CDN
You can also use the awesome CDN services from jsDelivr or UNPKG.
Do you use tail.writer in one of your project? Don't wait, write us at firstname.lastname@example.org and get listed below too!
- Octicons for the cute Icons
- jsCompress for the Compressor
- prismJS for the Syntax highlighting library
- MenuSpy for the Menu Navigation
The Documentation has been moved to GitHubs Wiki Pages, but I will keep a table of contents list here and some basic instructions.
- Install & Embed
- Default Usage
- Available Options
- Available Methods
- Events & Callbacks
- Internal Variables & Methods
- HowTos, Tips & Tricks
The tail.writer package contains many files and directories, which may confuse. The
folder can be ignored, unless you want to write a completely own design using the icon set or
one of our designs as basic template. Basically the
js folders (and the
langs directories maybe too) contains the main files, which you need to embed on your website.
The content within the
css folder should be self explanatory, the other ones contains these files:
js/tail.writer(.min).js- Contains the main script, WITHOUT any markup language.
js/tail.writer-<markup>(.min).js- Contains the main script, INCLUDING the named markup language.
js/tail.writer-full(.min).js- Contains the main script, INCLUDING ALL markup and interface languages.
langs/tail.writer-all.js- Contains all available interface languages.
langs/tail.writer-<lang_code>.js- Contains just the named interface language.
markups/tail.markup-all.js- Contains all available markup languages.
markups/tail.markup-<markup>.js- Contains just the named markup language.
In other words: No main action / button will be available if you just embed the
file. So either embed the desired markup language (within the
markups directory) too or use a
direct bundle (or the full package).
It's highly recommended to load the Stylesheet within your HTML Header, while you pass the
<body> tag (you can also include them before the
</body> tag, of course). Please make sure you load the Markup and Interface languages as
well as all plugins AFTER the main script. the
tail.writer() function should be called within
the "DOMContentLoaded" event.
You can pass up to 2 arguments to the tail.writer constructor, the first parameter is required
and need to be an
Element objects or
just a single selector as
String, which calls the
.querySelectorAll() method on its own.
The second parameter is optional and, if set, MUST be an
object with your tail.writer options.
Please check out GitHubs Wiki Pages to read more about each single option!
Copyright & License
Published under the MIT-License; Copyright © 2015 - 2019 SamBrishes, pytesNET