Skip to content
Browse files

vietnamsese_ids: update description

  • Loading branch information...
1 parent 3098de9 commit 11a33110e9549d43f27d8384ffd061864474f76e @icy icy committed Feb 10, 2013
Showing with 8 additions and 3 deletions.
  1. +8 −3 lib/kramdown/options.rb
View
11 lib/kramdown/options.rb
@@ -177,12 +177,17 @@ def self.simple_array_validator(val, name, size)
EOF
define(:vietnamese_ids, Boolean, true, <<EOF)
-Support Vietnamsese convertor ID generation
+Support Vietnamsese when generating header ID
If this option is `true` (and when `auto_ids` is true) ID values in
Vietnamese will be converted to a readable form (non-accent version
-of the origin text). This option should be used only if `auto_ids`
-is true.
+of the origin text).
+
+This option should be used only if `auto_ids` is true.
+
+Example: "Đây-là-ví-dụ" will generate new ID `day-la-vi-du` which is very
+readable by Vietnamese. When this option is `false`, its ID should be
+`y-l-v-d` which is unreadable (non-sense ID).
Default: true
Used by: HTML/Latex convertor

0 comments on commit 11a3311

Please sign in to comment.
Something went wrong with that request. Please try again.