Documentation of latex style functions

Documentation of latex style functions

[Heime]

Have made some Latex Style files with a number of functions and commands.

I would like to display some documentation for the Latex Style Functions
directly from Emacs.  What possibilities are there to do such a thing ?

\NewDocumentCommand {\Firzp} { s O{blue} O{it} m }
  {
    \group_begin:

    \color{#2}  % FYR-KLR

    \str_case:nnF {#3}  % FYR-SHP
      {
        %% Render in roman or italic type
        {rm} { \IfBooleanTF {#1}      % {string-case-1} {string-code-1}
                 { $\mathrm{#4}$ }
                   { \mathrm{#4} } }

        {it} { \IfBooleanTF {#1}      % {string-case-2} {string-code-2}
                 { $\mathit{#4}$ }
                   { \mathit{#4} } }
      }

        %% {false-code} NotIn{#3,(rm,it)}
        {
          \IfBooleanTF {#1}
            { $\mathit{#4}$ }
              { \mathit{#4} }
        }

    \group_end:

  }  % \wvFyrZp ends here

Re: Documentation of latex style functions

[Emanuel Berg]

Heime wrote:

> I would like to display some documentation for the Latex
> Style Functions directly from Emacs. What possibilities are
> there to do such a thing ?

I think this is a good starting point

  https://www.emacswiki.org/emacs/LaTeX

As a side note, here is my modest contribution to the
Emacs/LaTeX world. I actually did a lot of LaTeX from Emacs
but only such small configuration and extension.
Probably a good thing!

   https://dataswamp.org/~incal/emacs-init/latex.el

But nothing to address your specific desire.

I did more for Bibtex tho,

  https://dataswamp.org/~incal/emacs-init/bibtex/

but again nothing up the on-the-fly documentation alley.

-- 
underground experts united
https://dataswamp.org/~incal

Re: Documentation of latex style functions

[Heime]

On Saturday, December 30th, 2023 at 1:07 PM, Emanuel Berg <incal@dataswamp.org> wrote:

> Heime wrote:
> 
> > I would like to display some documentation for the Latex
> > Style Functions directly from Emacs. What possibilities are
> > there to do such a thing ?
> 
> 
> I think this is a good starting point
> 
> https://www.emacswiki.org/emacs/LaTeX
> 
> As a side note, here is my modest contribution to the
> Emacs/LaTeX world. I actually did a lot of LaTeX from Emacs
> but only such small configuration and extension.
> Probably a good thing!
> 
> https://dataswamp.org/~incal/emacs-init/latex.el
> 
> But nothing to address your specific desire.

What I have done is to make a .el file with functions that can
be called to show documentation information.  Like so. 

Would you have some suggestions upon improvements ?

(defconst FirZp-vaj-doc
  "
 \\NewDocumentCommand {\\FirZp} { s O{blue} O{it} m }

 \\FirZp [FIR-KLR] [FIR-SHP] {FIR-KWD}

 Let FIR-KLR Colour
     FIR-SHP Shape {it,rm}
     FIR-KWD Keyword
")


(defun FirZp-vaj ()

  ;; Print documentation about \FirZp.
  (:documentation
   (concat
     FirZp-vaj-doc)))

 
> I did more for Bibtex tho,
> 
> https://dataswamp.org/~incal/emacs-init/bibtex/
> 
> but again nothing up the on-the-fly documentation alley.
> 
> --
> underground experts united
> https://dataswamp.org/~incal