dobidi/bidify-rb

Add bidi support to HTML, helping to show RTL and LTR text in the correct direction regardless of the overall direction of the page.

Bidify (Ruby)

Bidify helps to add bidirectional text support to HTML documents.

The project is in its very early stage of development, and its interface or functionality may break from one version to another. Use it with caution.

Usage

require 'bidify'

html_input = '<p>some content even in nested format</p>'
bidified_html = Bidify.bidify_html_string(html_input)
# bidified_html: '<p dir="auto">some content even in nested format</p>' 

Rules

Bidification (the dir="auto" attribute) follows these simple rules:

• It applies to "bidifiable" tags.
• It excludes the first immediate child element.
• It excludes li tags.

The default bidifiable tags are div, h1, h2, h3, h4, h5, h6, p, ul, ol, and blockquote. One can modify this list using options.

As a complementary step, CSS styles should use logical properties. Here are a few examples:

/* Physical properties */
text-align: left;
padding-right: 10px;
border-left: 1px;
/* Logical properties */
text-align: start;
padding-inline-end: 10px;
border-inline-start: 1px;

Configuration

To use this gem with custom configuration, use the following syntax and pass options while creating an instance of bidifier:

options = {
  # ...
}

bidifier = Bidify::HtmlStringBidifier.new(options)

puts bidifier.apply('<div>input stringified html</div>')

Options

Available options with their default values are as follows:

• excluding_tags: []

  Removes tags from the list of bidifiable tags. This option affects the provided tags in including_tags options.

• including_tags: []

  Adds new tags to the list of bidifiable tags

• greedy: false

  By default, bidification stops when it reaches an element that has dir attribute. Use true to disregard any existing dir attributes.

• only_tags: []

  It sets the bidifiable tags to the given tags.

• with_table_support: false

  Use true to add table tags support.

License

This project is a Free/Libre and Open Source software released under LGPLv3 license.

bidify-rb's Issues

Add support for tables

With reference to iMrDJAi/bidimarkdown-spec#5

Add option for bidifiable tags

Add an option to add/remove tags to be bidified with the following options:

• including: []
• excluding: []
• only: []

Add option for form support

Add an option for supporting form elements (rather than adding them manually using the including_tags option)

It should include:

• input
• textarea
• label

Other form elements need more investigation.

Stop bidification when reached an element with explicit dir attribute

By default, add bidi to nested elements until we reach an element with an explicit dir attribute.

We can add a greedy option to ignore this and continue bidification deeper in the tree.