Browse Source

Some tweaks to the README

[skip ci]
dev
Andy Meneely 11 years ago
parent
commit
7360c8f550
  1. 21
      README.md

21
README.md

@ -245,15 +245,18 @@ end
If you want to do specialized formatting within a given string, Squib has lots of options. By setting `markup: true`, you enable tons of text processing. This includes: If you want to do specialized formatting within a given string, Squib has lots of options. By setting `markup: true`, you enable tons of text processing. This includes:
* Pango Markup. This is an HTML-like formatting language that specifies formatting inside your string. Pango Markup essentially supports any formatting option, but on a letter-by-letter basis. Such as: font options, letter spacing, gravity, color, etc. See the [Pango docs](https://developer.gnome.org/pango/stable/PangoMarkupFormat.html) for details. * Pango Markup. This is an HTML-like formatting language that specifies formatting inside your string. Pango Markup essentially supports any formatting option, but on a letter-by-letter basis. Such as: font options, letter spacing, gravity, color, etc. See the [Pango docs](https://developer.gnome.org/pango/stable/PangoMarkupFormat.html) for details.
* Quotes are converted to their curly counterparts where appropriate (i.e. “smart quotes” instead of "straight quotes"). * Quotes are converted to their curly counterparts where appropriate (i.e. “smart quotes” instead of "straight quotes").
* Apostraphes are converted to curly as well. * Apostraphes are converted to curly as well.
* LaTeX-style quotes are explicitly converted (<tt>``like this''</tt>) * LaTeX-style quotes are explicitly converted (<tt>``like this''</tt>)
* Em-dash and en-dash are converted with triple and double-dashes respectively (<tt>--</tt> is an en-dash, and <tt>---</tt> becomes an em-dash.) * Em-dash and en-dash are converted with triple and double-dashes respectively (<tt>--</tt> is an en-dash, and <tt>---</tt> becomes an em-dash.)
* Ellipses can be specified with <tt>...</tt>. Note that this is entirely different from the `ellipsize` option, which is determining what to do with overflowing text. * Ellipses can be specified with <tt>...</tt>. Note that this is entirely different from the `ellipsize` option (which determines what to do with overflowing text).
The above replacements assume you are using the UTF-8 character set. If you wish to change the characters, set the following configuration options in your `config.yml` A few notes:
* Smart quoting assumes the UTF-8 character set.
* Pango markup uses an XML/HTML-ish processor. Some characters require HTML-entity escaping (e.g. `&amp;` for `&')
### Text Sample
```yaml ```yaml
lsquote: "\u2018" #note that Yaml wants double quotes here to use escape chars lsquote: "\u2018" #note that Yaml wants double quotes here to use escape chars
rsquote: "\u2019" rsquote: "\u2019"

Loading…
Cancel
Save