summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/inlinelabel/inlinelabel-en.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/inlinelabel/inlinelabel-en.md')
-rw-r--r--macros/latex/contrib/inlinelabel/inlinelabel-en.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/macros/latex/contrib/inlinelabel/inlinelabel-en.md b/macros/latex/contrib/inlinelabel/inlinelabel-en.md
new file mode 100644
index 0000000000..dd726d5533
--- /dev/null
+++ b/macros/latex/contrib/inlinelabel/inlinelabel-en.md
@@ -0,0 +1,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/) \ No newline at end of file