Conditional use of commands in pgfkeys code - TeX

Skillmon replying to निरंजन

I doubt that there are so many smoother key=value interfaces, `pgfkeys` is ranked among the best. And the question is not whether I prefer some other package but whether you'd understand the documentation of it better, so I don't see much sense in providing an equivalent solution using some other key=value parser. You can take a look at [this list](https://tex.stackexchange.com/questions/26771/a-big-list-of-every-keyval-package) to get an overview of available packages (and then take a quick look at their documentation). Stay an arm-length away from anything some random dude commented with:
  
> Shouldn't be used as it loads the problematic catoptions package.

निरंजन replying to Skillmon

Thanks for this suggestion. I will see its documentation. If you have time and interest, you might also want to contribute on [this](https://topanswers.xyz/tex?q=1063) question, by providing a smoother key-val interface for this need. Meanwhile I'll try to work it out with other packages :)

निरंजन

I will definitely try other packages.

निरंजन replying to Skillmon

Actually I used the code given by JouleV which used `pgfkeys`. I really have no experience of using key-value interfaces

निरंजन replying to Skillmon

Okay.

Skillmon replying to निरंजन

Also, you might want to consider using `pgfopts` to use `pgfkeys` for package options (there is more to package options than just the parsing, LaTeX has also some facilities to keep track of unused and unknown options etc., all of which is correctly supported by `pgfopts`)

Skillmon replying to निरंजन

And if you don't understand the documentation of `pgfkeys` , you're not forced to use it, there are other key=value packages out there.

Skillmon replying to निरंजन

None that I know of except for the `pgfmanual`.

निरंजन replying to Skillmon

Thanks, I will do these changes and release a new version. Is there any good document for learning `pgfkeys`? The package documentation seems very short. I was not able to understand it properly.

Skillmon replying to निरंजन

And the `\selectfont` can be removed from lines 247 and 248.

Skillmon replying to निरंजन

You're missing a `\SingleSpacing` at the end of line 247.

निरंजन

The code ranges from [line 233](https://gitlab.com/niranjanvikastambe/marathi/-/blob/master/marathi/marathi.dtx#L233) to [line 257](https://gitlab.com/niranjanvikastambe/marathi/-/blob/master/marathi/marathi.dtx#L257) of the .dtx file.

निरंजन replying to Skillmon

Sorry, I should have mentioned this. I am using [v1.4](https://www.ctan.org/pkg/marathi) (the latest one). It uses the same code that you have so far suggested :)

Skillmon replying to निरंजन

I can't debug without seeing the contents of the `marathi` package's version in use while you're facing that error.

निरंजन replying to Skillmon

The `अंतर` parameter for setting global `stretch` in the package option which used to work earlier, doesn't seem to work now.  
  
```  
\documentclass{memoir}
\usepackage[अंतर=5]{marathi}

\begin{document}
\begin{abstract}
\परिच्छेद
\end{abstract}
\tableofcontents
\section{पहिला}
\परिच्छेद
\section{दुसरा}
\परिच्छेद
\section{तिसरा}
\परिच्छेद
\end{document}  
```

निरंजन

Oh okay :) Now everything is clear. I will soon release the package. Thanks for your help

Skillmon replying to निरंजन

yeah, I had the same issue. That's why I renamed it to `delme2` (for delete me, but I already had a file called that way, hence the 2).

निरंजन

The problem was not on your side, I was using a wrong package name in the filecontents environment. Thanks, your code works now.

निरंजन replying to Skillmon

Sorry will do that from now on

निरंजन replying to Skillmon

I tried it, but it didn't work then, let me check it again. **Edit : Checked ([still not working.](https://pastebin.com/AEs08Zb0))**  
 
*Edit : Problem solved. XeLaTeX was using `marathi` package from my TeX installation. Renaming the file to some other random name worked out properly.*

Skillmon replying to निरंजन

also, if you reply instead of just write, I get notified of your message and don't have to periodically check whether there is an answer :)

Skillmon replying to निरंजन

oh, yes, I had to rename `marathi` to `delme2`... it should work now.

निरंजन

Sorry but your MWE doesn't compile for me. It doesn't even load package `marathi`. Primary error that I get is package `delme2` not found. I tried replacing it with `marathi`, but that too does not work. Does the MWE compile for you?

Skillmon replying to निरंजन

The issue is rather simple, if `memoir` is used `setspace` isn't loaded (even if you do `\RequirePackage{setspace}`), and in `memoir` the correct macro name isn't `\singlespacing`, but `\SingleSpacing`. So all you have to do is switch out `\singlespacing` in the `memoir`-is-loaded case:  
  
```  
\begin{filecontents}{marathi.sty}
\ProvidesPackage{marathi}
\RequirePackage{pgfkeys}
\RequirePackage{setspace}
\def\बदल#1{\pgfqkeys{/marathi}{#1}}
\newcommand*\marathi@baselineskip{1.5}
\pgfkeys
{%
    marathi/.is family, marathi/.cd,
    अंतर/.store in=\marathi@baselineskip,
    अंतर/.default=1
}
\AtBeginDocument
{%
    \@ifclassloaded{memoir}
    {%
        \setSingleSpace{\marathi@baselineskip}\selectfont
        \pgfkeys{marathi/अंतर/.code=\setSingleSpace{#1}\selectfont\SingleSpacing}%
    }%
    {%
        \setstretch{\marathi@baselineskip}%
        \pgfkeys{marathi/अंतर/.code=\setstretch{#1}}%
    }%
}
\DeclareOption*{\expandafter\बदल\expandafter{\CurrentOption}}
\providecommand{\अंतरबदल}[1]{\बदल{अंतर=#1}}
\ProcessOptions\relax
\end{filecontents}

\documentclass{memoir}
\usepackage{marathi}
\usepackage{lipsum}

\begin{document}
\lipsum[1-1]

\अंतरबदल{5}
\lipsum[1-1]
\end{document} 
```

निरंजन

`\अंतरबदल` which is an equivalent of `\change` doesn't work.

निरंजन

[XeLaTeX log](https://pastebin.com/qKnZiXK2) & [LuaLaTeX log](https://pastebin.com/jHzZ2XdW)

निरंजन

Yes. I used XeLaTeX

Skillmon replying to निरंजन

Did you use XeTeX or LuaTeX (didn't take a look, yet, just want to make sure I'm testing the right things...)

निरंजन

@Skillmon I tried your solution with `\setSingleSpace` command suggested by Ulrike Fischer, it works as expected. See the following code.  
  
```  
\begin{filecontents}{test.sty}
\ProvidesPackage{test}
\RequirePackage{pgfkeys}
\RequirePackage{setspace}
\def\marathiset#1{\pgfqkeys{/test}{#1}}
\newcommand*\marathi@baselineskip{1.5}
\pgfkeys
{%
    test/.is family, test/.cd,
    baseline/.store in=\marathi@baselineskip,
    baseline/.default=1
}
\AtBeginDocument
{%
    \@ifclassloaded{memoir}
    {%
        \setSingleSpace{\marathi@baselineskip}\selectfont
        \pgfkeys{test/baseline/.code=\setSingleSpace{#1}\selectfont
        \singlespacing}%
    }%
    {%
        \setstretch{\marathi@baselineskip}%
        \pgfkeys{test/baseline/.code=\setstretch{#1}}%
    }%
}
\DeclareOption*{\expandafter\marathiset\expandafter{\CurrentOption}}
\providecommand{\change}[1]{\marathiset{baseline=#1}}
\ProcessOptions\relax
\end{filecontents}

\documentclass{memoir}
\usepackage{test}
\usepackage{lipsum}

\begin{document}
\lipsum[1-1]

\change{5}
\lipsum[1-1]
\end{document}  
```  
  
but if I change the characters in the macros with Unicode characters, it doesn't work. You can check this code.  

```  
\begin{filecontents}{marathi.sty}
\ProvidesPackage{marathi}
\RequirePackage{pgfkeys}
\RequirePackage{setspace}
\def\बदल#1{\pgfqkeys{/marathi}{#1}}
\newcommand*\marathi@baselineskip{1.5}
\pgfkeys
{%
    marathi/.is family, marathi/.cd,
    अंतर/.store in=\marathi@baselineskip,
    अंतर/.default=1
}
\AtBeginDocument
{%
    \@ifclassloaded{memoir}
    {%
        \setSingleSpace{\marathi@baselineskip}\selectfont
        \pgfkeys{marathi/अंतर/.code=\setSingleSpace{#1}\selectfont
        \singlespacing}%
    }%
    {%
        \setstretch{\marathi@baselineskip}%
        \pgfkeys{marathi/अंतर/.code=\setstretch{#1}}%
    }%
}
\DeclareOption*{\expandafter\बदल\expandafter{\CurrentOption}}
\providecommand{\अंतरबदल}[1]{\बदल{अंतर=#1}}
\ProcessOptions\relax
\end{filecontents}

\documentclass{memoir}
\usepackage{marathi}
\usepackage{lipsum}

\begin{document}
\lipsum[1-1]

\अंतरबदल{5}
\lipsum[1-1]
\end{document}  
```  

Can you please confirm whether this problem is created by the characters or I've made a mistake in the coding. As far as I can see code is exactly the same, but I might have missed something. If this is a problem of Unicode characters, I will open up an issue for this on pgfkeys repository.

Skillmon replying to निरंजन

No, everything should work with that line. It is only used if the class `memoir` isn't loaded (the test is done beforehand, the key's code is defined in a way that the test has only be done once inside of `\AtBeginDocument` and afterwards `baseline` should be well-behaved).

samcarter replying to निरंजन

You must not use `\@ifclassloaded` in your document body

निरंजन

@Skillmon @samcarter   
```#21
\pgfkeys{test/baseline/.code=\setstretch{#1}}%
```

This line should also be conditional, right? Otherwise the `\change` command does not work in `memoir`. I tried this, but no luck :( I wonder why `\@ifclassloaded` is not working in a conditional statement.

```  
\pgfkeys{marathi/अंतर/.code=\@ifclassloaded{memoir}
{\setSingleSpace{#1}}{\setstretch{#1}}}  
```

निरंजन

@Skillmon have a look at [this answer](https://tex.stackexchange.com/a/444222/174620).

निरंजन

Doesn't work on my machine too.

Skillmon replying to samcarter

but seems to not work (at least in a quick test without further digging)

Skillmon replying to samcarter

sounds way better than using `\linespread` directly! Though the name is really strange...

samcarter

@निरंजन  Ulrike Fischer just told me that "the memoir equivalent to the `\setstretch` of setspace (which does more as it resets some settings e.g. in footnotes) is `\setSingleSpace{factor}`."

निरंजन

@frougon, re: [your answer](#a1451), Thanks. I'll try this too :)

samcarter replying to Skillmon

I have to agree, not because it is yours but because it is better :)

Skillmon replying to निरंजन

mine has a drawback as well, the `baseline` key will not be defined in the preamble, but I can fix that. **Edit:** fixed.

Skillmon replying to निरंजन

I'd say mine, but of course I'd say mine, it is mine after all :)

samcarter replying to Skillmon

I also added a warning about these edge cases

samcarter replying to Skillmon

Thanks for the reminder! I removed the line endings.

Skillmon replying to निरंजन

yes, I had the `\selectfont` on the wrong code line :) Should be fixed.

निरंजन

@Skillmon, At least on my system [your answer](#a1449) does not change the `baselinestretch` when memoir class is loaded. Try this code.
  
```
\documentclass{memoir}
\usepackage{test}
\usepackage{lipsum}

\begin{document}
\change{5}
\lipsum[1-1]
\end{document}  
```  
  
but @samcarter's answer does that. I don't know which one is functionally better.

Skillmon

Also you should comment out the line endings after `\linespread{#1}` and `\setstretch{#1}`, they will not be ignored.

Skillmon

@samcarter, re: [your answer](#a1450), I'd not test this during package load time. While it is fine to have a package internal conditional reflecting whether `memoir` is loaded or not, you really should check for it only `\AtBeginDocument`, imagine a class file doing this:  
  
```  
\RequirePackage{test}  
\ProvidesClass{Foo}  
\LoadClass{memoir}  
```

Skillmon replying to samcarter

Problem is, that this way `\marathiset` is only usable in the preamble, if that's intended everything is fine (except that a `\@onlypreamble\marathiset` is missing).

samcarter

```  
\documentclass{memoir}
\usepackage{lipsum}

\begin{filecontents*}[overwrite]{test.sty}
\ProvidesPackage{test}
\RequirePackage{pgfkeys}
\RequirePackage{setspace}
\def\marathiset#1{\pgfkeys{test/.cd,#1}}
\pgfkeys{
    test/.is family,test/.cd,
    baseline/.code={\@ifclassloaded{memoir}{\linespread{#1}}{\setstretch{#1}}\selectfont},
    baseline=1.5,
    baseline/.default=1
}
\DeclareOption*{\expandafter\marathiset\expandafter{\CurrentOption}}
\providecommand{\change}[1]{\marathiset{baseline=#1}}
\ProcessOptions
\end{filecontents*}

\usepackage{test}

\change{5}

\begin{document}

        \lipsum[1-1]
\end{document}  
```

3 Answers