Re: [help-texinfo] How to make a redirect to an existing item

2017-08-22 Thread Gavin Smith
On Sun, Aug 20, 2017 at 03:54:04AM -0400, Alfred M. Szmidt wrote:
>> I have some documentation and one of the items is @deffn adjoint. I'd
>> like to have another item, adjugate, of some type, which just says
>> something like 'adjugate: see adjoint.'
>> 
>> Is there a kind of @foo that I could use for adjugate that's
>> appropriate here? I guess I could make a @deffn adjugate and then have
>> the body of the description just say 'see @xref{adjoint}' or something
>> like that. But maybe this kind of redirection is already defined
>> somehow.
> 
>Unfortunately, there is no way to make an index entry refer to another 
>one like this.
> 
> That isn't really right, @deffnx is the right way of doing this, and
> then one can use @anchor to define the reference.

Of course, you are right here. I was thinking of putting the 
cross-reference directly in the index entry, which isn't possible. If 
you have two items you want to document together, of course you can use 
@deffn and @deffnx. Thanks.



Re: [help-texinfo] How to make a redirect to an existing item

2017-08-20 Thread Alfred M. Szmidt
   > I have some documentation and one of the items is @deffn adjoint. I'd
   > like to have another item, adjugate, of some type, which just says
   > something like 'adjugate: see adjoint.'
   > 
   > Is there a kind of @foo that I could use for adjugate that's
   > appropriate here? I guess I could make a @deffn adjugate and then have
   > the body of the description just say 'see @xref{adjoint}' or something
   > like that. But maybe this kind of redirection is already defined
   > somehow.

   Unfortunately, there is no way to make an index entry refer to another 
   one like this.

That isn't really right, @deffnx is the right way of doing this, and
then one can use @anchor to define the reference.

  @deffn Function adjoin
  @deffnx Function adjugate
  @anchor{Definition of adjoin}
  @anchor{Definition of adjugate}
  Frobnicate the adjugation by doing an adjoin on the frob.
  @end deffn
  
  @xref{Definition of frob} for awesomeness.

You could also do "@deffn .. adjugate", followed by a @xref{Defintion
of adjoin}, but that is kinda ugly.



Re: [help-texinfo] How to make a redirect to an existing item

2017-08-19 Thread Gavin Smith
On Sat, Aug 12, 2017 at 12:49:09PM -0700, Robert Dodier wrote:
> Hi,
> 
> I have some documentation and one of the items is @deffn adjoint. I'd
> like to have another item, adjugate, of some type, which just says
> something like 'adjugate: see adjoint.'
> 
> Is there a kind of @foo that I could use for adjugate that's
> appropriate here? I guess I could make a @deffn adjugate and then have
> the body of the description just say 'see @xref{adjoint}' or something
> like that. But maybe this kind of redirection is already defined
> somehow.

Unfortunately, there is no way to make an index entry refer to another 
one like this.



[help-texinfo] How to make a redirect to an existing item

2017-08-12 Thread Robert Dodier
Hi,

I have some documentation and one of the items is @deffn adjoint. I'd
like to have another item, adjugate, of some type, which just says
something like 'adjugate: see adjoint.'

Is there a kind of @foo that I could use for adjugate that's
appropriate here? I guess I could make a @deffn adjugate and then have
the body of the description just say 'see @xref{adjoint}' or something
like that. But maybe this kind of redirection is already defined
somehow.

Thanks for your help, I appreciate it.

Robert Dodier