Telling auctex to format a user-defined command as \item ?

Telling auctex to format a user-defined command as \item ?

[Adam Funk]

(Crossposted; please feel free to follow-up to either group as I read
both of them.)

I have the following definitions in the preamble:

#v+
\newcommand{\slug}{\hspace{1.0em}}
\newcommand{\object}[1]{\textsf{#1}}
\newcommand{\method}[3]{\item{\slug}\object{#1}{\slug}\url{#2}{\slug}#3}
#v-

So I have lists with this sort of thing:

#v+
\begin{itemize}
  \method{GET}{http://localhost:port/documents}{lists all document ids.}
  \method ...
#v-

The formatting commands (indent-region, fill-region, etc.) aren't
keeping the \method commands on separate lines (like \item) because
latex-mode/auctex doesn't know what they are.  What magic do I need to
use to tell it to format \method like \item?

Thanks,
Adam

Re: Telling auctex to format a user-defined command as \item ?

[Tassilo Horn]

Adam Funk <a24061@ducksburg.com> writes:

Hi Adam,

> I have the following definitions in the preamble:
>
> #v+
> \newcommand{\slug}{\hspace{1.0em}}
> \newcommand{\object}[1]{\textsf{#1}}
> \newcommand{\method}[3]{\item{\slug}\object{#1}{\slug}\url{#2}{\slug}#3}
> #v-
>
>
> So I have lists with this sort of thing:
>
> #v+
> \begin{itemize}
>   \method{GET}{http://localhost:port/documents}{lists all document ids.}
>   \method ...
> #v-
>
> The formatting commands (indent-region, fill-region, etc.) aren't
> keeping the \method commands on separate lines (like \item) because
> latex-mode/auctex doesn't know what they are.  What magic do I need to
> use to tell it to format \method like \item?

Does it help to adapt `LaTeX-item-regexp' so that it also recognizes
your \method macros at items?

Bye,
Tassilo

Re: Telling auctex to format a user-defined command as \item ?

[Adam Funk]

On 2014-09-20, Tassilo Horn wrote:

> Adam Funk <a24061@ducksburg.com> writes:
...
>> So I have lists with this sort of thing:
>>
>> #v+
>> \begin{itemize}
>>   \method{GET}{http://localhost:port/documents}{lists all document ids.}
>>   \method ...
>> #v-
>>
>> The formatting commands (indent-region, fill-region, etc.) aren't
>> keeping the \method commands on separate lines (like \item) because
>> latex-mode/auctex doesn't know what they are.  What magic do I need to
>> use to tell it to format \method like \item?
>
> Does it help to adapt `LaTeX-item-regexp' so that it also recognizes
> your \method macros at items?

Good suggestion!  I found the following in .emacs from a previous
customization to handle \boxedverbatim & such:

#v+
(defcustom LaTeX-verbatim-regexp ".*verbatim\\*?"
  "*Regexp matching environments with indentation at col 0 for begin/end."
  :group 'LaTeX-indentation
  :type 'regexp)
#v-

and, working from that & the output of C-h f LaTeX-item-regexp,
arrived at this

#v+
(defcustom LaTeX-item-regexp "\\(\\(bib\\)?item\\|method\\)\\b"
  "*Regular expression matching macros considered items."
  :group 'LaTeX-indentation
  :type 'regexp)
#v-

which works!  

Thanks very much for putting me on the right track.

Adam

Re: Telling auctex to format a user-defined command as \item ?

[Tassilo Horn]

Adam Funk <a24061@ducksburg.com> writes:

Hi Adam,

> Good suggestion!  I found the following in .emacs from a previous
> customization to handle \boxedverbatim & such:
>
> #v+
> (defcustom LaTeX-verbatim-regexp ".*verbatim\\*?"
>   "*Regexp matching environments with indentation at col 0 for begin/end."
>   :group 'LaTeX-indentation
>   :type 'regexp)
> #v-
>
> and, working from that & the output of C-h f LaTeX-item-regexp,
> arrived at this
>
> #v+
> (defcustom LaTeX-item-regexp "\\(\\(bib\\)?item\\|method\\)\\b"
>   "*Regular expression matching macros considered items."
>   :group 'LaTeX-indentation
>   :type 'regexp)
> #v-
>
> which works!  
>
> Thanks very much for putting me on the right track.

Good, but you shouldn't use `defcustom' for your configurations else the
emacs help facilities will say that those variables are defined in your
init file, won't show the real (upstream) default values, and the links
go into you init file instead to the file where the package in question
defines the variable.  Use a simple `setq'.

  (setq LaTeX-verbatim-regexp ".*verbatim\\*?"
        LaTeX-item-regexp "\\(\\(bib\\)?item\\|method\\)\\b")

Bye,
Tassilo

Re: Telling auctex to format a user-defined command as \item ?

[Adam Funk]

On 2014-09-21, Tassilo Horn wrote:

> Good, but you shouldn't use `defcustom' for your configurations else the
> emacs help facilities will say that those variables are defined in your
> init file, won't show the real (upstream) default values, and the links
> go into you init file instead to the file where the package in question
> defines the variable.  Use a simple `setq'.
>
>   (setq LaTeX-verbatim-regexp ".*verbatim\\*?"
>         LaTeX-item-regexp "\\(\\(bib\\)?item\\|method\\)\\b")

I've changed it to that & it works too.  I can't explain where I got
the defcustom from --- I must've seen it in some similar-looking
situation & misadopted it.  thanks.