Re: [Docutils-users] broken rst cheatsheet?

[David G. <go...@py...>]

Thanks, I added something like that.

-- DG

On Tue, Feb 19, 2013 at 9:38 AM, Peter Funk <pf...@ar...> wrote:
> David Goodger schrieb am Dienstag, den 19.02.2013 um 09:01:
>> On Tue, Feb 19, 2013 at 3:23 AM, Guenter Milde <mi...@us...> wrote:
>> > On 2013-02-18, David Goodger wrote:
>> >> Regardless of the bug in LaTeX formatting, the cheatsheet
>> >> (http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt) is
>> >> really meant to be used in text (.txt) form. When it is processed,
>> >> much of the useful information disappears. It's meant as a reminder of
>> >> reST syntax.
>> >
>> >> So I recommend referring to the .txt original, rather than processing
>> >> it to .html or .pdf.
>> >
>> > Maybe we can extempt the cheatsheet from the files translated by the
>> > html-builder then?
>>
>> Why bother? We only have links to cheatsheet.txt. The fact that
>> cheatsheet.html exists doesn't bother me.
>>
>> At most I'd add a note, "If you're reading this as HTML, please see
>> `<cheatsheet.txt>`_ instead.
> ...
>
> +1
>
> --- cheatsheet.txt.orig 2013-02-19 16:31:47.040172793 +0100
> +++ cheatsheet.txt      2013-02-19 16:36:37.540228881 +0100
> @@ -7,6 +7,12 @@
>  :Revision: $Revision: 7463 $
>  :Description: This is a "docinfo block", or bibliographic field list
>
> +IMPORTANT NOTE
> +==============
> +If you're reading this text as HTML, please click
> +`<cheatsheet.txt>`_ instead first.  Otherwise you will
> +**NOT** see the reStructuredText input syntax examples!
> +
>  Section Structure
>  =================
>  Section titles are underlined or overlined & underlined.
>
>
> Regards, Peter Funk
> --
> Peter Funk, home: ✉Oldenburger Str.86, D-27777 Ganderkesee
> mobile:+49-179-640-8878 phone:+49-421-20419-0 <http://www.artcom-gmbh.de/>
> office: ArtCom GmbH, ✉Haferwende 2, D-28357 Bremen, Germany