tipauni-help


Search for: Advanced

Re: [tipauni-help] How to create tipauni.sty


Disclaimer:
------------------------------------------------------------
This email was supposed to be a part of the thread titled as
"how to create tipauni.sty" posted on Tue, 25 Jan 2022
19:05:57, but as I hadn't subscribed to the list earlier, I
couldn't directly reply to it. Sorry for the inconvenience.
------------------------------------------------------------

First of all if you have a TeX Live installation which is
2020 or later you might simply want to use the tlmgr program
specifically developed for installing unreleased LaTeX
packages. Your command should look like:

  tlmgr install tipauni

Note that this command installs the tipauni package in your
TeX-system. So it is very easy to use tipauni from any
directory in your system. Otherwise you will have to
copy-paste the tipauni.sty in every folder where your
working TeX-file is located. Also note that this is the most
secure and safe way to use the latest copy. It is even
better than using the .sty generated from the latest
git-branch as the the git-branch might have some so called
bleeding edge features.

Now coming back to your actual question. The following
explanation assumes that you have successfully cloned the
git-repository of `tipauni' with the following command.

  git clone git://git.gnu.org.ua/tipauni.git

and the following directory structure should be visible:

  .
  ├── COPYING
  ├── README.txt
  └── tipauni
      ├── build.lua
      ├── support
      │   └── gfdl-tex.tex
      ├── testfiles
      │   ├── edgecases-for-parser.luatex.tlg
      │   ├── edgecases-for-parser.lvt
      │   ├── edgecases-for-parser.tlg
      │   ├── edgecases-for-parser.xetex.tlg
      │   ├── t-command.lvt
      │   ├── t-command.tlg
      │   ├── tipauni-commands.lvt
      │   ├── tipauni-commands.tlg
      │   └── tipauni-commands.xetex.tlg
      ├── tipauni-commands.pdf
      ├── tipauni-commands.tex
      ├── tipauni.dtx
      ├── tipauni-example.pdf
      ├── tipauni-example.tex
      ├── tipauni.ins
      └── tipauni.pdf

  (Note: I have skipped hidden files.)

Now the process for generating the `tipauni.sty' is very
simple. There are two ways to achieve this. I'll explain
both of them.

* Run the following command in the tipauni/tipauni
  directory:

  latex tipauni.ins

  This is not just true for the tipauni package, but in fact
  true for _any_ LaTeX package which provide the source code
  with a .dtx and .ins pair. So running the latex (similarly
  pdf/xe/lualatex) on <pkg>.ins will produce <pkg>.sty or
  <pkg>.cls files. It is the de facto standard in LaTeX
  package development.

* The second way might be a bit more lengthy, but definitely
  more useful. It makes the use of the powerful l3build
  program. The build.lua file has the configuration for
  building the tipauni.sty from it's sources. This file is
  compiled with the l3build command, but in order to use it
  you need to ensure the following steps.

  - You have a 2020+ TeX Live installation.
    I can't check this. You'll have to check it yourself.
  - You have a folder named texmf in your home directory.
    If you are unsure, just issue:

      mkdir ~/texmf

    If you have a directory named texmf in your home
    directory, this command will do nothing and prompt you
    with an error. If you don't have it will be created
    silently. So in both the cases you are safe.

After this you can issue:

  l3build install

in the tipauni/tipauni directory which will automatically
install the latest version (with bleeding edge features
sometimes) of the package.

I hope this helps. Feel free to ask any other questions.

Cheers,
निरंजन