MediaWiki

https://wiki.luatex.org/
Admin
MediaWiki is the free and open-source wiki software that powers Wikipedia, allowing anyone to create...
Tokens:1,811,062
Snippets:24,293
Trust Score:9.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Basic TikZ and LuaTeX Setup

Source: https://wiki.luatex.org/index.php?diff=10870&oldid=148&title=Writing_Lua_in_TeX

A standard LaTeX document setup using the TikZ package for drawing and amsmath for mathematical formulas. This serves as a boilerplate for examples involving graphical elements and mathematical typesetting.

```tex
\documentclass[tikz,border=3mm]{standalone}
\usepackage{amsmath} % 用于数学公式
\usetikzlibrary{positioning, arrows.meta}
\begin{document}
\begin{tikzpicture}[
 box/.style={draw, rectangle, minimum width=2cm, minimum height=1cm, thick},
 ell/.style={draw, ellipse, minimum width=0.8cm, minimum height=0.8cm},
 arrow/.style={-Stealth, thick}
]

% 上半部分：直接效应模型
% 节点定义

```

--------------------------------

### Create a PDF Link Node

Source: https://wiki.luatex.org/api.php?action=feedcontributions&feedformat=atom&user=Patrick

Demonstrates creating a PDF link using start and end nodes, setting attributes, and packing them into an hbox.

```lua
local start_link = node.new("whatsit","pdf_start_link")
local end_link = node.new("whatsit","pdf_end_link")
 
start_link.width = tenpt
start_link.height = tenpt / 2
start_link.depth = tenpt / 2
start_link.link_attr = "/C [0.9 1 0] /Border [0 0 2]"
 
start_link.action = node.new("action")
start_link.action.action_type = 1
start_link.action.action_id = dest
 
local rule = mkrule(tenpt)
local hbox = hpack(start_link, rule, end_link)
add_to_page(hbox)
 
shipout()
```

--------------------------------

### LaTeX Document with LuaTeX Hyphenation Example

Source: https://wiki.luatex.org/index.php?oldid=60&title=Show_the_hyphenation_points

A basic LaTeX document setup that includes the necessary packages and the Lua code to demonstrate showing hyphenation points. Ensure you have 'blindtext' and 'fontspec' packages installed.

```latex
\documentclass[12pt,a4paper]{scrartcl}
\usepackage[english]{babel}
\usepackage{blindtext}
\usepackage{fontspec}
\directlua{
show_hyph = function(head) 
  while head do
    if head.id == 0 or head.id == 1 then % hlist, vlist
      show_hyph(head.list) % should be head.head in a newer luatex than 0.64
    elseif head.id == 7 then             % disc
      local n = node.new("whatsit","pdf_literal")
      n.mode = 0
      n.data = "q 0.3 w 0 2 m 0 7 l S Q"
      n.next = head.next
      n.prev = head
      head.next = n
      head = n
    end
  head = head.next
  end
  return true
end
luatexbase.add_to_callback("post_linebreak_filter",show_hyph,"show_hyph")

}

\begin{document}
\begin{minipage}{5cm}
\blindtext
\end{minipage}
\end{document}

```

--------------------------------

### Initialize LuaTeX output

Source: https://wiki.luatex.org/index.php?action=history&feed=atom&title=Use_a_TrueType_font

Basic setup for enabling PDF output and direct Lua execution.

```tex
\pdfoutput1
```

```tex
\directlua{
```

--------------------------------

### List users starting at Y

Source: https://wiki.luatex.org/api.php?action=help&modules=query%2Ballusers

Example request to enumerate users starting from the letter Y.

```http
api.php?action=query&list=allusers&aufrom=Y
```

--------------------------------

### Initialize luatex-plain format

Source: https://wiki.luatex.org/api.php?action=feedcontributions&feedformat=atom&user=73.170.253.19

Command to initialize the luatex-plain format file.

```bash
luatex --ini /usr/local/share/texmf-dist/tex/generic/context/luatex/luatex-plain.tex
```

--------------------------------

### Get pages containing files

Source: https://wiki.luatex.org/api.php?action=help&recursivesubmodules=1

Uses the generator to retrieve pages that contain the files starting from B.

```http
api.php?action=query&generator=allfileusages&gaffrom=B
```

--------------------------------

### Basic TikZ Diagram Setup

Source: https://wiki.luatex.org/index.php?diff=10870&oldid=49&printable=yes&title=Writing_Lua_in_TeX

Sets up styles for boxes, ellipses, and arrows for drawing diagrams. Includes document structure and TikZ environment.

```tex
\usepackage{amsmath} % 用于数学公式  
\usetikzlibrary{positioning, arrows.meta}  

\begin{document}
\begin{tikzpicture}[
 box/.style={draw, rectangle, minimum width=2cm, minimum height=1cm, thick},
 ell/.style={draw, ellipse, minimum width=0.8cm, minimum height=0.8cm},
 arrow/.style={-Stealth, thick}
 ]
  
% 上半部分：直接效应模型  
% 节点定义  
\node[box] (X1) at (0,0) {$Flex_{it}$};
\node[box] (Y1) at (4,0) {$Y_{lnincomeit}$};
\node[ell] (e1) at (6,0) {$e1$};
% 路径连接  
\draw[arrow] (X1) -- node[above] {$c$} (Y1);
\draw[arrow] (Y1) -- (e1);
% 方程标注  
\node[align=center] (eq1) at (2,-1)   
 {$Y_{lnincomeit} = c Flex_{it} + e1$};
  
% 下半部分：中介效应模型  
% 节点定义  
\node[box] (X2) at (0,-3) {$Flex_{it}$};
\node[box] (M) at (2,-5) {$M_{it}$};
\node[box] (Y2) at (4,-3) {$Y_{lnincomeit}$};
\node[ell] (e2) at (4,-5) {$e2$};
\node[ell] (e3) at (6,-3) {$e3$};
% 路径连接  
\draw[arrow] (X2) -- node[above] {$c'$} (Y2);
\draw[arrow] (X2) -- node[above,sloped] {$a$} (M);
\draw[arrow] (M) -- node[above,sloped] {$b$} (Y2);
\draw[arrow] (M) -- (e2);
\draw[arrow] (Y2) -- (e3);
% 方程标注  
\node[align=center] (eq2) at (2,-6)   
 {$M_{it} = a Flex_{it} + e2$};
\node[align=center] (eq3) at (2,-7)   
 {$Y_{lnincomeit} = c' Flex_{it} + b M_{it} + e3$};
  \end{tikzpicture}  
\end{document}
```

--------------------------------

### Get pages containing redirects

Source: https://wiki.luatex.org/api.php?action=help&recursivesubmodules=1

This generator retrieves pages that contain redirects, starting from the redirect title 'B'.

```api
api.php?action=query&generator=allredirects&garfrom=B
```

--------------------------------

### Constructing a PDF Page with Nodes

Source: https://wiki.luatex.org/index.php?action=edit&title=TeX_without_TeX&undo=10845&undoafter=118

Demonstrates creating a link action, a rule, and packing them into an hbox for output via shipout.

```lua
start_link.link_attr = "/C [0.9 1 0] /Border [0 0 2]"

--start_link.action = node.new("action")
--there has been an update of the luatex
start_link.action = node.new("whatsit","pdf_action")
start_link.action.action_type = 1
start_link.action.action_id = dest

local rule = mkrule(tenpt)
local hbox = hpack(start_link, rule, end_link)
add_to_page(hbox)

-- This pagelist consists of an hbox whose contents is "start_link",
-- the 10pt x 10pt rule and the "end_link" node.

shipout()
---------------------------

-- Just to show you that you can get some memory usage statistics:
print(string.format("\nnode_mem_usage=%s",status.node_mem_usage))
```

--------------------------------

### Get pages containing transclusions

Source: https://wiki.luatex.org/api.php?action=help&modules=query%2Balltransclusions

Uses the module as a generator to retrieve the pages that contain the transclusions starting from 'B'.

```http
api.php?action=query&generator=alltransclusions&gatfrom=B
```

--------------------------------

### Using tex.print()

Source: https://wiki.luatex.org/api.php?action=feedcontributions&feedformat=atom&user=123.153.212.119

Shows equivalent ways to pass strings to TeX and how to apply a specific catcode table.

```lua
tex.print("a", "b")
tex.print({"a", "b"})
```

```tex
a
b
```

```tex
\bgroup
\initcatcodetable1
\catcode`\_=0
\savecatcodetable1
\egroup

\directlua{tex.print(1, "_TeX")}
```

--------------------------------

### Initialize LuaTeX utilities and modules

Source: https://wiki.luatex.org/index.php?oldid=3567&printable=yes&title=T_wo_T_r%3Atest.lua

Imports necessary utility, REPL, reader, command, page, and formatting modules to the global scope for script execution.

```lua
--- Everything is global, so that it will be available in the REPL


--- For use in REPL, not used here

util = require("utils")

sp_to_p  = util.sp_to_p
sp_to_in = util.sp_to_in

node_type    = util.node_type
node_subtype = util.node_subtype

link_nodes = util.link_nodes

make_glyph     = util.make_glyph
make_glue      = util.make_glue
make_glue_spec = util.make_glue_spec
make_rule      = util.make_rule
make_penalty   = util.make_penalty

fil   = util.fil
fill  = util.fill
filll = util.filll

is_whitespace         = util.is_whitespace
is_linefeed           = util.is_linefeed
is_nobreak            = util.is_nobreak
is_command_terminator = util.is_command_terminator

copy_table = util.copy_table

read_string = util.read_string
read_group  = util.read_group

walk_table = util.walk_table
show_node  = util.show_node
walk_list  = util.walk_list


--- For use here


repl = require("repl")

repl = repl.repl


reader = require("reader")

push_reader = reader.push_reader


commands = require("commands")


pages = require("pages")

build_pages = pages.build_pages
build_page = pages.build_page


main = require("main")

main_loop = main.main_loop


format = require("format")

main_text_tbl = format.main_text_tbl
push_tbl      = format.push_tbl
```

--------------------------------

### Fetch Revisions of Pages with Prefix

Source: https://wiki.luatex.org/index.php/Special%3AApiHelp/query

This example shows how to fetch revisions for pages whose titles start with a specific prefix.

```APIDOC
## GET api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue=

### Description
Fetches revisions of pages whose titles begin with the prefix 'API/'.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Set to 'query'.
- **generator** (string) - Required - Specifies a generator to use, e.g., 'allpages'.
- **gapprefix** (string) - Required - The prefix to filter page titles.
- **prop** (string) - Required - Specifies the properties to retrieve, e.g., 'revisions'.
- **continue** (string) - Optional - Used for continuation of paginated results.
```

--------------------------------

### Initialize Lua Environment

Source: https://wiki.luatex.org/api.php?action=feedcontributions&feedformat=atom&user=Rkrug

Setup global utilities and module requirements for the LuaTeX typesetting environment.

```lua
--- Everything is global, so that it will be available in the REPL


--- For use in REPL, not used here

util = require("utils")

sp_to_p = util.sp_to_p
sp_to_in = util.sp_to_in

node_type = util.node_type
node_subtype = util.node_subtype

link_nodes = util.link_nodes

make_glyph = util.make_glyph
make_glue = util.make_glue
make_glue_spec = util.make_glue_spec
make_rule = util.make_rule
make_penalty = util.make_penalty

fil = util.fil
fill = util.fill
filll = util.filll

is_whitespace = util.is_whitespace
is_linefeed = util.is_linefeed
is_nobreak = util.is_nobreak
is_command_terminator = util.is_command_terminator

copy_table = util.copy_table

read_string = util.read_string
read_group = util.read_group

walk_table = util.walk_table
show_node = util.show_node
walk_list = util.walk_list


--- For use here


repl = require("repl")

repl = repl.repl


reader = require("reader")

push_reader = reader.push_reader


commands = require("commands")


pages = require("pages")

build_pages = pages.build_pages
build_page = pages.build_page


main = require("main")

main_loop = main.main_loop


format = require("format")

main_text_tbl = format.main_text_tbl
push_tbl = format.push_tbl


--- Do the job


function do_job()
push_reader("file:text.tex")
push_tbl(main_text_tbl)
main_loop()
build_pages()
end

do_job()


--- Enter REPL for exploration

--- repl()
```

--------------------------------

### Get first 5 revisions after a specific date

Source: https://wiki.luatex.org/api.php?action=help&modules=query&submodules=1

Retrieves the first 5 revisions of the Main Page starting from a specific timestamp.

```text
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z
```

--------------------------------

### Initialize Command Table and Metatable

Source: https://wiki.luatex.org/index.php?oldid=3563&title=T_wo_T_r%3Acommands.lua

Sets up a command registry with a metatable that triggers an error when accessing undefined commands.

```lua
local command_table = {}


local mt = {__index = function (_, command)
              error("Bad Command:" .. command)
            end
           }

setmetatable(command_table, mt)


local register_command = function(name, func)
  command_table[name] = func
end
```

--------------------------------

### Get All Submodules of a Query Module

Source: https://wiki.luatex.org/api.php?action=help&modules=paraminfo

This example demonstrates how to fetch information for all submodules of a specific module, such as 'query', by using the wildcard character '*'.

```api
api.php?action=paraminfo&modules=query%2B*
```

--------------------------------

### Initialize main.lua Module

Source: https://wiki.luatex.org/index.php?action=history&feed=atom&title=T_wo_T_r%3Amain.lua

Sets up the main module table and imports necessary dependencies for node manipulation, reading, and formatting.

```lua
local main = {}
package.loaded[...] = main


local util = require("utils")

local link_nodes = util.link_nodes
local make_glyph = util.make_glyph
local make_glue = util.make_glue
local make_penalty = util.make_penalty
local is_whitespace = util.is_whitespace
local is_linefeed = util.is_linefeed
local is_nobreak = util.is_nobreak
local copy_table = util.copy_table
local read_line = util.read_line


local reader = require("reader")

local read_value = reader.read_value


local format = require("format")

local update_state = format.update_state
local update_locals = format.update_locals
local push_tbl = format.push_tbl
local pop_tbl = format.pop_tbl
local top_tbl = format.top_tbl
local pop_do_command_stop = format.pop_do_command_stop


local commands = commands or require("commands")

local get_command = commands.get_command
local initialize_command = commands.initialize_command


local pages = pages or require("pages")

local build_par = pages.build_par
local process_par = pages.process_par
```

--------------------------------

### Get all target pages, marking missing ones

Source: https://wiki.luatex.org/api.php?action=help&recursivesubmodules=1

This generator fetches all target pages and marks the missing ones. It starts from the redirect title 'B'.

```api
api.php?action=query&generator=allredirects&garunique=&garfrom=B
```

--------------------------------

### Create and Shipout PDF Link Nodes

Source: https://wiki.luatex.org/index.php?action=edit&title=TeX_without_TeX&undo=122&undoafter=121

Constructs a PDF link using whatsit nodes and ships the resulting hbox to the output.

```lua
local start_link = node.new("whatsit","pdf_start_link") local end_link = node.new("whatsit","pdf_end_link") start_link.width = tenpt start_link.height = tenpt / 2 start_link.depth = tenpt / 2 start_link.link_attr = "/C [0.9 1 0] /Border [0 0 2]" --start_link.action = node.new("action") --there has been an update of the luatex start_link.action = node.new("whatsit","pdf_action") start_link.action.action_type = 1 start_link.action.action_id = dest local rule = mkrule(tenpt) local hbox = hpack(start_link, rule, end_link) add_to_page(hbox) -- This pagelist consists of an hbox whose contents is "start_link", -- the 10pt x 10pt rule and the "end_link" node. shipout() --------------------------- -- Just to show you that you can get some memory usage statistics: print(string.format("\nnode_mem_usage=%s",status.node_mem_usage))
```

--------------------------------

### Get User Contributions by IP Prefix

Source: https://wiki.luatex.org/api.php?action=help&recursivesubmodules=1

Retrieve contributions from all IP addresses starting with a given prefix. This is useful for analyzing edits from a range of IP addresses.

```api
api.php?action=query&list=usercontribs&ucuserprefix=192.0.2.
```

--------------------------------

### Get Site Info in PHP Format

Source: https://wiki.luatex.org/api.php?action=help&modules=phpfm

Use this example to retrieve site information, specifically the namespaces, formatted as PHP. This requires read access to the API.

```api
api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm
```

--------------------------------

### Initialize LuaTeX Page Layout

Source: https://wiki.luatex.org/index.php?action=history&feed=atom&title=T_wo_T_r%3Aformat.lua

Sets up basic TeX page dimensions and baselineskip for the document layout.

```lua
tex.baselineskip = tex.sp("14pt")

-- set tex's margins to the edge of the page, so that we can define
-- our own page layout more easily
tex.hoffset = tex.sp("-1.in")
tex.voffset = tex.sp("-1.in")
```

--------------------------------

### Initialize Page Layout Parameters

Source: https://wiki.luatex.org/index.php/Special%3ASearch/T_wo_T_r%3Aformat.lua

Sets up TeX offsets and paper dimensions for a custom page layout.

```lua
local util = require("utils")

local filll = util.filll


-----------------------------------------------------------------


--- Page Layout


-- This should be set based on the current font!
tex.baselineskip = tex.sp("14pt")

-- set tex's margins to the edge of the page, so that we can define
-- our own page layout more easily
tex.hoffset = tex.sp("-1.in")
tex.voffset = tex.sp("-1.in")


-- American paper size. USA!
local paper_width  = tex.sp("8.5in")
local paper_height = tex.sp("11in")

local top_margin    = tex.sp("0.75in")
local right_margin  = tex.sp("0.75in")
local bottom_margin = tex.sp("0.75in")
local left_margin   = tex.sp("0.75in")

-- header_height is the height of the header box, and it is
-- separated from the main text box by header_sep.
local header_height = tex.sp("0.5in")
local header_sep    = tex.sp("0.25in")

local footer_height = tex.sp("0.5in")
local footer_sep    = tex.sp("0.25in")

-- The main text box.
local text_width  = paper_width - (right_margin + left_margin)
local text_height = paper_height - (top_margin +
                                    header_height + header_sep +
                                    footer_height + footer_sep +
                                    bottom_margin)


local page_number = 1
```

--------------------------------

### Example of Section Markup Usage

Source: https://wiki.luatex.org/index.php?diff=prev&oldid=84&printable=yes&title=Process_input_buffer

Demonstrates the usage of hash-based markup for creating sections, subsections, and subsubsections. Lines starting with '#', '##', or '###' (ignoring leading/trailing spaces) are converted to corresponding TeX commands.

```text
# A section
  ## A subsection
    ### A subsubsection

```
Tokens:
Raw