]> git.lyx.org Git - features.git/blob - lib/layouts/ruby.module
New module for Ruby (furigana) text.
[features.git] / lib / layouts / ruby.module
1 #\DeclareLyXModule{Ruby (Furigana)}
2 #\DeclareCategory{Annotation & Revision}
3 #DescriptionBegin
4 #Defines an inset to typeset reading aids (ruby, furigana) to Chinese
5 #characters. Uses the "okumakro", "luatexja-ruby", or "ruby" package
6 #(depending on the TeX engine) or a fallback definition.
7 #DescriptionEnd
8 #Requires
9 #Excludes
10
11 #Authors: Koji Yokota (original implementation as local layout),
12 #         Günter Milde <milde@lyx.org> (module)
13
14 Format 74
15
16 InsetLayout Flex:Ruby
17         LyxType         charstyle
18         LatexType       command
19         LatexName       ruby
20         BgColor         none
21         LabelString     "Ruby"
22         Decoration      Conglomerate
23         Preamble
24           \ifdefined\kanjiskip
25             \IfFileExists{okumacro.sty}{\usepackage{okumacro}}{}
26           \else \ifdefined\luatexversion
27             \usepackage{luatexja-ruby}
28           \else \ifdefined\XeTeXversion
29             \usepackage{ruby}%
30           \fi\fi\fi
31           \providecommand{\ruby}[2]{\shortstack{\tiny #2\\#1}}
32         EndPreamble
33         Argument        post:1
34                 LabelString     "ruby text"
35                 MenuString      "Ruby Text|R"
36                 Tooltip         "Reading aid (ruby, furigana) for Chinese characters."
37                 Decoration      Conglomerate
38                 Font
39                   Size          tiny
40                 EndFont
41                 LabelFont
42                   Size          tiny
43                 EndFont
44                 Mandatory       1
45         EndArgument
46 End