[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [O] setting local variables

From: Nicolas Goaziou
Subject: Re: [O] setting local variables
Date: Wed, 06 Sep 2017 15:08:13 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/25.2 (gnu/linux)

Rasmus <address@hidden> writes:

> I could not get it to work.  I tried stuff like "[[(org) Tables]]",
> "[[*(org) Tables]]" and , [[texinfo:(org) tables]].

You are talking about a special case for cross-referencing (which could
include internal reference, URL referencess). This is the job of


> It is always unresolved.  I couldn’t think of any other way of referencing
> an external manual, even skimming ox-texinfo.el, so it is not
> straightforward to me.


  [[info:org#External links]]

oops, I mean 

  (info "(org) External links")


> That is why I asked for a reference as I do not remember having seen such
> a layout in an info page.  If we know of an example, it might not be hard
> to implement.

The problem is not implementing it, really. It is about finding a way to
integrate it with Org syntax.

"org.texi" uses a lot of "@subheading" and related. See for example

  (info "(org) Installation")

"Using Emacs packaging system", "Downloading Org as an archive" and
"Using Org's git repository" are three examples of such layout.

>> What it sophisticated referencing? "ox-texinfo" supports internal and
>> external links without specific syntax. @pxref and @xref is just
>> syntactic sugar over @ref.
>> "ox-texinfo.el" supports @email, @ref and @uref.
> I don’t know as I am not a texinfo expert, but in the texinfo manual they
> tell you to be vary of @ref.  It is probably a bit over the top.
>     The @ref command can tempt writers to express themselves in a manner
>     that is suitable for a printed manual but looks awkward in the Info
>     format. Bear in mind that your audience could be using both the
>     printed and the Info format. For example:
>     Sea surges are described in @ref{Hurricanes}.
>     looks ok in the printed output:
>         Sea surges are described in Section 6.7 [Hurricanes], page 72. 
>     but is awkward to read in Info, “note” being a verb:
>     Sea surges are described in *note Hurricanes::.

In Org, just write

  For sea surges, see [[*Hurricanes]]

E.g., insert the "see" manually.

> Also, does Org support all four @ref arguments?  In either case, these are
> questions that I find reasonable and cannot find the answer to in the
> manual.

The manual is not targeted to Texinfo experts. The difference between
@ref arguments are subtle. At this point, I suggest to generate some
template with Org and tweak the result.

BTW, Org supports @ref with 1 argument and with arguments 1 and 3. There
is no way in Org to distinguish between online label and printed label.
The fourth and fifth arguments are not supported either, for the same
reason. You need to insert raw Texinfo code to achieve this.

> I guess the idea of Texinfo is produce info, html, and paper manuals
> consistently, though.  I personally agree, but just look at the Org manual
> and the fuss about @code vs @samp (which, I believe, are also displayed in
> the same way).

@code and @samp are not a problem, being respectively ~...~ and =...=.

> Texinfo is proudly pedantic. People exporting to Texinfo might care
> about @kbd{} vs @code{} and explaining how to get such fine-grained
> control would be a fine thing to document in the manual IMO.

Patch welcome!

Also, two emphasis markers are unused in "ox-texinfo.el": _..._ and
+...+. Another solution would be to use them for Texinfo special markup.
However, it feels awkward to provide this by default.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]