summaryrefslogtreecommitdiff
path: root/obsolete/macros/context/contrib/context-ruby/doc/context/third/ruby/README
blob: 6e6fcd4ad6b77daef88a65e07321138a0bb6cb06 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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[..,..=..,..]{...}{...}