emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Rasmus <rasmus@gmx.us>
To: emacs-orgmode@gnu.org
Subject: Re: setting local variables
Date: Wed, 06 Sep 2017 14:42:29 +0200	[thread overview]
Message-ID: <87h8wgov62.fsf@gmx.us> (raw)
In-Reply-To: 87mv68159v.fsf@nicolasgoaziou.fr

Hi,

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> Rasmus <rasmus@gmx.us> writes:
>
>> Eric Abrahamsen <eric@ericabrahamsen.net> writes:
>>
>>> The only real problem I encountered was that links to external Info
>>> manuals did not export correctly, and couldn't be followed. I gave up on
>>> learning the exact syntax of texinfo's @[px]ref commands because it was
>>> dinnertime, but I can figure out what went wrong and maybe provide a
>>> patch.
>>
>> I am not sure either.  I couldn’t get cross-referencing working.
>>
>>     http://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Cross-References
>>
>> The texinfo part of the Org manual could use a section on
>> cross-referencing
>
> IIRC, cross-referencing is straightforward. It should just work.

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

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.

>>> The other thing I'd like to know is how to "inline" sections (ie output
>>> several sections on a single page), but still have links to those
>>> sections work correctly.
>>
>> Are you talking about info pages now?  Because in pdf and html it’s not an
>> issue as far as I’m aware.
>
> The OP is probably talking about @heading and al. 
>
> There is actually no way to specify such a "nodeless" heading (more
> exactly, an unnumbered heading that doesn't appear in the table of
> contents), because I couldn't find any appealing syntax (i.e., not too
> low level, and, if possible, generic enough).
>
> I agree this is the last major issue in this export back-end.

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.

> 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::.

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.

>> Another area that seems slightly lacking is support for all markings, so
>> perhaps there could be a section on accessing your favorite via
>> ‘org-texinfo-text-markup-alist’ (if ‘org-texinfo--text-markup’ supports
>> it) and the rest via macros, if necessary.
>>
>>     http://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Marking-Text
>
> IMO, advanced marking is not needed, at least out of the box. For
> example, @kbd{M-@key{TAB}} in Texinfo is morally equivalent to ~M-<TAB>~
> in Org, as long as the document targets info.
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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).  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.

Rasmus

-- 
Hooray!

  reply	other threads:[~2017-09-06 12:44 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-08-02 21:53 setting local variables Eric Abrahamsen
2017-08-02 22:10 ` Kaushal Modi
2017-08-02 22:15   ` Eric Abrahamsen
2017-08-03 10:52 ` Nicolas Goaziou
2017-08-03 16:11   ` Eric Abrahamsen
2017-08-03 22:02     ` Nicolas Goaziou
2017-08-03 22:49       ` Eric Abrahamsen
2017-08-04  0:42         ` Eric Abrahamsen
2017-08-04 15:37           ` Nicolas Goaziou
2017-08-05  1:06             ` Eric Abrahamsen
2017-08-05  8:50               ` Nicolas Goaziou
2017-08-05 19:14                 ` Eric Abrahamsen
2017-09-05 11:48     ` Rasmus
2017-09-05 16:57       ` Eric Abrahamsen
2017-09-06  8:56         ` Rasmus
2017-09-06 10:38           ` Nicolas Goaziou
2017-09-06 12:42             ` Rasmus [this message]
2017-09-06 13:08               ` Nicolas Goaziou
2017-09-06 16:33                 ` Eric Abrahamsen
2017-09-06 16:57                   ` Nicolas Goaziou
2017-09-06 17:44                     ` Eric Abrahamsen
2017-09-07  8:56                     ` Rasmus
2017-09-07 12:48                       ` Nicolas Goaziou
2017-09-07 15:01                         ` Eric Abrahamsen
2017-09-10 13:55                           ` Nicolas Goaziou
2017-09-20 16:17                           ` Carsten Dominik
2017-09-20 18:42                             ` Scott Randby
2017-09-20 23:16                               ` Kaushal Modi
2017-09-21  8:38                                 ` Carsten Dominik
2017-09-21  9:39                                   ` Rasmus
2017-09-21  9:58                                     ` Carsten Dominik
2017-09-21 19:21                                       ` Nicolas Goaziou
2017-09-21 21:25                                         ` Kaushal Modi
2017-09-22  7:22                                         ` Carsten Dominik
2017-09-22  9:09                                         ` Rasmus
2017-09-21 13:00                                 ` Scott Randby
2017-09-21  7:45                               ` Eric S Fraga

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87h8wgov62.fsf@gmx.us \
    --to=rasmus@gmx.us \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).