README.md in truncate_html-0.9.2 vs README.md in truncate_html-0.9.3
- old
+ new
@@ -1,36 +1,38 @@
TruncateHtml
============
[](http://travis-ci.org/hgmnz/truncate_html)
-[](https://codeclimate.com/github/hgmnz/truncate_html)
+[](https://codeclimate.com/github/hgmnz/truncate_html)
truncate_html cuts off a string of HTML and takes care of closing any lingering open tags. There are many ways to solve this. This library does not have any dependencies, and [parses HTML using regular expressions](http://stackoverflow.com/questions/1732348/regex-match-open-tags-except-xhtml-self-contained-tags/1732454#1732454).
It can be used with or without Rails.
Example
-------
```ruby
some_html = '<ul><li><a href="http://whatever">This is a link</a></li></ul>'
-truncate_html(some_html, :length => 15, :omission => '...(continued)')
+truncate_html(some_html, length: 15, omission: '...(continued)')
=> <ul><li><a href="http://whatever">This...(continued)</a></li></ul>
```
A few notes:
* By default, it will truncate on word boundary.
- To truncate the HTML string strictly at the specified length, pass in the `:word_boundary => false` option.
+ To truncate the HTML string strictly at the specified length, pass in the `word_boundary: false` option.
* If the input HTML is nil, it will return an empty string.
* The omission text's length does count toward the resulting string's length.
* `<script>` tags will pass right through - they will not count toward the resulting string's length, or be truncated.
* The default options are:
- * `:length`: 100
- * `:omission`: '...'
- * `:word_boundary`: /\S/
+```
+length: 100
+omission: '...'
+word_boundary: /\S/
+```
You may also set global configuration options.
For example, place the following on application boot,
something like `config/initializers/truncate_html.rb`
@@ -48,17 +50,17 @@
TruncateHtml.configure do |config|
config.word_boundary = /\S[\.\?\!]/
end
```
-You can also truncate the html at a specific point not based on length but content.
+You can also truncate the HTML at a specific point not based on length but content.
To do that, place the `:break_token` in your source. This allows the truncation to be
data driven, breaking after a leading paragraph or sentence. If the
-`:break_token` is in your content before the specified :length, :length will be
-ignored and the content truncated at :break_token
-If the `:break_token` is in your content after the specified :length,
-`:break_token` will be ignored and the content truncated at :length
+`:break_token` is in your content before the specified `:length`, `:length` will be
+ignored and the content truncated at `:break_token`.
+If the `:break_token` is in your content after the specified `:length`,
+`:break_token` will be ignored and the content truncated at `:length`.
```ruby
TruncateHtml.configure do |config|
config.break_token = '<!-- truncate -->'
end
@@ -81,11 +83,13 @@
Found an issue or have a suggestion? Please report it on [Github's issue tracker](http://github.com/hgmnz/truncate_html/issues).
Testing
-------
- bundle
- rake
+```shell
+bundle
+rake
+```
All green? Go hack.
Copyright (c) 2009 - 2010 Harold A. Giménez, released under the MIT license