unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Jonathan Leech-Pepin <jonathan.leechpepin@gmail.com>
To: xfq.free@gmail.com
Cc: emacs-devel@gnu.org
Subject: Re: Integrating new "GNU Emacs Contributing Guide" into Emacs web pages.
Date: Tue, 23 Apr 2013 10:08:17 -0400	[thread overview]
Message-ID: <CAEWDx5dKUMj1h9oULjVPAh=4rV5_WX+WF3b8NMj-mtzVo9zusg@mail.gmail.com> (raw)

Hello Xue,

Assuming you're working from a .org file (since you mentioned
ox-texinfo.el).  If not this will likely not be of any relevance.

> Here is the very first version in Texinfo format.  There are some
> issues:
>
> 1. no EDITION

There is no direct support for exporting variables to texinfo.  If
working directly from the org file at all times, you can replace it
with an Org macro which will serve a similar purpose.

To export the variables to .texi you could do the following:

1. Allow texinfo snippets

   (add-to-list 'org-export-snippet-translation-alist
                '("info" . "texinfo"))

2. Use the following in the document

   #+TEXINFO: @set EDITION <edition>
   #+MACRO: edition @@info:@value{EDITION}@@

   Then use {{{edition}}} anywhere you wish the variable to be
   inserted.

> 2. no @copying

To create a @copying section in the texinfo document you need to
create a headline in the org file with a :copying: property set to a
non-nil value.  It will be inserted at the right location on export
(regardless of where it is found in the org document) and will not
appear anywhere else.

Do not include any subheadings, the exporter will try to export them
as @section/@subsection... which will cause issues.

> 3. no @documentencoding

This is fixed as of commit 'fea4b5c'.  Previously it would only
include @documentencoding if `org-texinfo-coding-system' was set.  Now
it will default to `buffer-file-coding-system'.

> 4. no introduction in Top node

At the moment the closest option (I intend to improve it) is that any
text before the first headline will be in the @top node, however it
will appear after the menu (as opposed to before it).

> 5. TODO of this guide can be moved to etc/TODO
>
> I don't have time resolving them now, can anyone familiar with
> Texinfo help?
>
> --
> Best regards, Xue Fuqiao.
> http://www.gnu.org/software/emacs/

--
Regards,
Jon



             reply	other threads:[~2013-04-23 14:08 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-23 14:08 Jonathan Leech-Pepin [this message]
2013-04-23 22:48 ` Integrating new "GNU Emacs Contributing Guide" into Emacs web pages Xue Fuqiao
2013-04-23 23:15   ` Xue Fuqiao
2013-04-25  7:02     ` Glenn Morris
2013-04-25 13:43       ` Stefan Monnier
2013-04-25 22:34       ` Xue Fuqiao
  -- strict thread matches above, loose matches on Subject: below --
2013-04-22 13:05 GNU Emacs Contributing Guide xfq
2013-04-22 16:30 ` Karl Fogel
2013-04-22 16:35   ` Glenn Morris
2013-04-22 16:54     ` Integrating new "GNU Emacs Contributing Guide" into Emacs web pages Karl Fogel
2013-04-22 17:09       ` Bastien
2013-04-22 17:13         ` Karl Fogel
2013-04-22 17:15           ` Bastien
2013-04-22 22:38           ` Xue Fuqiao
2013-04-22 17:44       ` Glenn Morris
2013-04-22 18:13         ` Karl Fogel
2013-04-22 22:51           ` Xue Fuqiao
2013-04-23  1:00             ` Xue Fuqiao
2013-04-23  3:34               ` Stefan Monnier
2013-04-23  3:32       ` Stefan Monnier
2013-04-23  4:37         ` Xue Fuqiao
2013-04-23  4:49           ` Xue Fuqiao

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.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to='CAEWDx5dKUMj1h9oULjVPAh=4rV5_WX+WF3b8NMj-mtzVo9zusg@mail.gmail.com' \
    --to=jonathan.leechpepin@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=xfq.free@gmail.com \
    /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.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).