-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathgloss_render.Rd
57 lines (46 loc) · 1.4 KB
/
gloss_render.Rd
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/gloss_render.R
\encoding{UTF-8}
\name{gloss_render}
\alias{gloss_render}
\alias{gloss_pdf}
\alias{gloss_html}
\alias{gloss_tooltip}
\alias{gloss_leipzig}
\alias{gloss_word}
\title{Render a gloss}
\usage{
gloss_pdf(gloss)
gloss_html(gloss, numbering = TRUE)
gloss_tooltip(gloss, numbering = TRUE)
gloss_leipzig(gloss, numbering = TRUE)
gloss_word(gloss, numbering = TRUE)
}
\arguments{
\item{gloss}{Object of class \code{\link{gloss_data}}}
\item{numbering}{Whether the gloss should be numbered (in HTML and Word).}
}
\value{
Object of class \code{\link[=new_gloss]{gloss}}.
}
\description{
These functions are output-specific and can be used to check the specific output
of certain calls, but are not meant to be used in an R Markdown file. Instead,
use \code{\link[=as_gloss]{as_gloss()}} or \code{\link[=gloss_df]{gloss_df()}}.
}
\section{Functions}{
\itemize{
\item \code{gloss_pdf()}: Render in PDF
\item \code{gloss_html()}: Render in HTML
\item \code{gloss_tooltip()}: Tooltip rendering for HTML
\item \code{gloss_leipzig()}: Leipzig.js engine
\item \code{gloss_word()}: Render in Word
}}
\examples{
ex_sp <- "Un ejemplo en español"
ex_gloss <- "DET.M.SG example in Spanish"
ex_trans <- "An example in Spanish"
my_gloss <- new_gloss_data(list(ex_sp, ex_gloss), translation = ex_trans, label="ex1")
gloss_pdf(my_gloss)
gloss_html(my_gloss)
}