summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/inlinelabel/inlinelabel-en.md
blob: dd726d5533f300961ce480adf559dc7c862125ad (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
44
45
46
47
48
49
50
51
52
53
54
55
# Inlinelabel Package

This package can assign equation numbers to inline equations. When Japanese is supported, you can switch to circled equation numbers.


## System Requirements

+ TeX format: LaTeX
+ Prerequisite package: amsmath and refcount
+ Prerequisite package with [circled] option: japanese-otf


## Installation

Move inlinelabel.sty file to $TEXMF/tex/latex/hideanswer.


## Usage

### \inlinelabel{<label>}

Put the inline equation number. Place it outside of the equation (outside of the $--$). Take the name of the label as an argument. Take a small margin before and after the text to make it look natural. If you don't want margins, use \inlinelabel*{<label>}.


### Option [circled]

Assuming you are using a Japanese environment. Switch to circled equation numbers. All equation numbers are rewritten, not just the inline equation numbers.


### \circledref{<label>}

Only valid when [circled] option is loaded.
Refer to the circled equation number.


### \equationref{<label>}

Only valid when [circled] option is loaded.
This macro is the same as \circledref{<label>}.


## License

This package released under [the MIT license](https://ctan.org/license/mit).


## Revision History

+ Version 1.0 2022-06-28
    + The first public version.


---

[Yukoh KUSAKABE](https://twitter.com/metaphysicainfo) (screen-name) at [metaphysica.info](https://www.metaphysica.info/)