sed-devel
[Top][All Lists]
Advanced

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

Re: [PATCH 1/4] doc: fix copy-pasted examples of regexp


From: Assaf Gordon
Subject: Re: [PATCH 1/4] doc: fix copy-pasted examples of regexp
Date: Thu, 9 Feb 2017 23:19:40 -0500

Hello Alexandre,

> On Feb 9, 2017, at 17:08, Alexandre Jasmin <address@hidden> wrote:
>>> [PATCH 2/4] doc: rework BRE/ERE table to fit PDF manual
>> 
>> Will need a bit more review, hope to have this soon.
> 
> It can definitely use more work. But the current formatting doesn't
> quite work either.

Agreed.
Pushed here with minor adjustments:
  http://git.savannah.gnu.org/cgit/sed.git/commit/?id=45aae495cb

I'm not entirely pleased with this 3x2 table.
I initially thought it would convey the BRE-vs-ERE
differences clearly, but the texinfo limitations
and the need to render it correctly in info,html,pdf
makes it less than pleasing.

I'm open to completely rewriting it if you have ideas
or suggestions.


>>> [PATCH 4/4] doc: reference the i command in /regexp/I

Pushed here:
http://git.savannah.gnu.org/cgit/sed.git/commit/?id=1c6030213b


>> However if you plan to send more patches (which we very much encourage!),
>> please fill out the copyright assignment form:
> 
> Done. Hope to contribute more as time permits.

Thank you for completing the copyright assignment process.
Looking forward to many more contributions.


> Something else I'd like to fix is the inconsistent use of
> @codequoteundirected and @codequotebacktick in the documentation.
> 
> In the PDF you often see both styles on the same page. Can't we just
> set that once and forget it?

This is actually a recent addition.
I'm happy to get suggestions and improvements.

My thinking is this: texinfo automatically converts quotes to directed
quotes. It looks very nice in PDF and HTML.
But it is annoying in examples, because it makes "copy & pasting"
impossible (the shell will reject the left-quote/right-quote unicode 
characters).

For now, I've manually added the "@codequoteXXX" around each "@example".
I didn't want to change quotes outside examples, as it will make
the rendered text ugly.

Another complication: turning off directed quotes is only available in
newer texinfo, which in turned necessitated this hack:
 
http://git.savannah.gnu.org/cgit/sed.git/tree/doc/config.texi?id=1c6030213be9a7e3cd5d#n11

If there's a way to automatically force it only in @examples,
I'm happy to use it. Other suggestions are also welcomed.

regards,
 - assaf






reply via email to

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