summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/context/third
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-01-28 01:16:34 +0000
committerKarl Berry <karl@freefriends.org>2010-01-28 01:16:34 +0000
commit86de9599eba062dde26d84887ba0d6c13e4bf6da (patch)
treef2517fa535448b3e970e305985f999b176e213c5 /Master/texmf-dist/doc/context/third
parentdb2715bbed9637c68e7761c488a68b2112c372f4 (diff)
new context package context-ruby (26jan10)
git-svn-id: svn://tug.org/texlive/trunk@16847 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/context/third')
-rw-r--r--Master/texmf-dist/doc/context/third/ruby/README43
1 files changed, 43 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/context/third/ruby/README b/Master/texmf-dist/doc/context/third/ruby/README
new file mode 100644
index 00000000000..6e6fcd4ad6b
--- /dev/null
+++ b/Master/texmf-dist/doc/context/third/ruby/README
@@ -0,0 +1,43 @@
+Modulename : t-ruby
+Author : Wolfgang Schuster
+License : Public Domain
+
+
+Description
+-----------
+
+The 'ruby' module allows users to write ruby annotations in ConTeXt.
+
+
+Usage
+-----
+
+The module is loaded with the command:
+
+ \usemodule[ruby]
+
+Ruby text can be set with the command:
+
+ \ruby{base text}{ruy text}
+
+The layout of the base and ruby text could be changed with:
+
+ \setupruby
+ [basestyle=...,
+ basecolor=...,
+ textstyle=...,
+ textcolor=...]
+
+Whether ruby text overlaps with the surrounding text or not can be configured with:
+
+ \setupruby
+ [overhang=auto|start|end|none] % default: yes
+
+The last option is the distance between the ruby and the base text:
+
+ \setupruby
+ [inbetween=...] % default: \blank[small]
+
+All of these parameters can also be changed for a single ruby command:
+
+ \ruby[..,..=..,..]{...}{...}