‘V’ ‘#+BEGIN_VERBATIM ... #+END_VERBATIM’ missing in manual(?)

‘V’ ‘#+BEGIN_VERBATIM ... #+END_VERBATIM’ missing in manual(?)

[Alain.Cochard]

Hello.

In section "15.2 Easy templates" of the manual, I think that under

   Org comes with these pre-defined easy templates:

the line related to VERBATIM is missing.

-- 
EOST (École et Observatoire des Sciences de la Terre) 
IPG (Institut de Physique du Globe) | alain.cochard@unistra.fr
5 rue René Descartes   [bureau 106] | Phone: +33 (0)3 68 85 50 44 
F-67084 Strasbourg Cedex, France    | Fax:   +33 (0)3 68 85 01 25     

Re: ‘V’ ‘#+BEGIN_VERBATIM ... #+END_VERBATIM’ missing in manual(?)

[Nicolas Goaziou]

Hello,

Alain.Cochard@unistra.fr writes:

> In section "15.2 Easy templates" of the manual, I think that under
>
>    Org comes with these pre-defined easy templates:
>
> the line related to VERBATIM is missing.

The "Easy templates" section does not exist anymore in new manual. Also,
there is no such thing as a "verbatim" environment.

IOW, it is already solved in master.

Regards,

-- 
Nicolas Goaziou

Re: ‘V’ ‘#+BEGIN_VERBATIM ... #+END_VERBATIM’ missing in manual(?)

[Alain.Cochard]

Nicolas Goaziou writes on Wed 13 Jun 2018 21:26:

 > The "Easy templates" section does not exist anymore in new
 > manual. Also, there is no such thing as a "verbatim" environment.
 > 
 > IOW, it is already solved in master.

Thanks for the feedback.

I had been made aware of the verbatim block type by the following
excerpt of section 14 (Working with source code) of the manual:

     Org’s ‘src’ code block type is one of many block types, such as
   quote, export, verse, latex, example, and verbatim.
   
If I am not mistaken, this excerpt is still present in the new
(master) version of the manual.


Also, I was a bit confused by section 15.2 (Structure Templates) of
the new manual.  The formatting suggests (to me anyway) that the list
at the end (a ‘#+BEGIN_EXPORT ascii’ . . . ‘#+END_EXPORT’, etc.)
indicates what can be obtained by the '< key TAB' mechanism when
org-tempo is enabled.  But since there is a one-to-one correspondence
between this list and the list inside org-structure-template-alist
[fn:1], it appears more specifically related to the default insertion
mechanism (that is, without org-tempo).

Sure, there is nothing wrong but maybe the formulation could be made
more explicit -- also listing the few keys specific of org-tempo could
help. 

[fn:1] Well, almost: the "E" entry is missing in the manual. 


Finally, looking at the docstring of org-tempo-keywords-alist, I think
the sentence

   For example "<l" at the beginning of a line...

should be 

   For example "<L" at the beginning of a line...


Regards

-- 
EOST (École et Observatoire des Sciences de la Terre) 
IPG (Institut de Physique du Globe) | alain.cochard@unistra.fr
5 rue René Descartes   [bureau 106] | Phone: +33 (0)3 68 85 50 44 
F-67084 Strasbourg Cedex, France    | Fax:   +33 (0)3 68 85 01 25     

Re: ‘V’ ‘#+BEGIN_VERBATIM ... #+END_VERBATIM’ missing in manual(?)

[Nicolas Goaziou]

Hello,

Alain.Cochard@unistra.fr writes:

> Nicolas Goaziou writes on Wed 13 Jun 2018 21:26:
>
>  > The "Easy templates" section does not exist anymore in new
>  > manual. Also, there is no such thing as a "verbatim" environment.
>  > 
>  > IOW, it is already solved in master.
>
> Thanks for the feedback.
>
> I had been made aware of the verbatim block type by the following
> excerpt of section 14 (Working with source code) of the manual:
>
>      Org’s ‘src’ code block type is one of many block types, such as
>    quote, export, verse, latex, example, and verbatim.
>    
> If I am not mistaken, this excerpt is still present in the new
> (master) version of the manual.

I don't think so. I couldn't find it in the guide either.

> Also, I was a bit confused by section 15.2 (Structure Templates) of
> the new manual.  The formatting suggests (to me anyway) that the list
> at the end (a ‘#+BEGIN_EXPORT ascii’ . . . ‘#+END_EXPORT’, etc.)
> indicates what can be obtained by the '< key TAB' mechanism when
> org-tempo is enabled.  But since there is a one-to-one correspondence
> between this list and the list inside org-structure-template-alist
> [fn:1], it appears more specifically related to the default insertion
> mechanism (that is, without org-tempo).
>
> Sure, there is nothing wrong but maybe the formulation could be made
> more explicit -- also listing the few keys specific of org-tempo could
> help. 

Feel free to send a patch if you think you can improve the wording.

> [fn:1] Well, almost: the "E" entry is missing in the manual.

Fixed. Thank you.

> Finally, looking at the docstring of org-tempo-keywords-alist, I think
> the sentence
>
>    For example "<l" at the beginning of a line...
>
> should be 
>
>    For example "<L" at the beginning of a line...

Fixed. Thank you.

Regards,

-- 
Nicolas Goaziou

Re: ‘V’ ‘#+BEGIN_VERBATIM ... #+END_VERBATIM’ missing in manual(?)

[Alain.Cochard]

Nicolas Goaziou writes on Thu 14 Jun 2018 20:43:

 > > [...] the following excerpt of section 14 (Working with source
 > > code) of the manual:
 > >
 > >      Org’s ‘src’ code block type is one of many block types, such
 > >    as quote, export, verse, latex, example, and verbatim.
 > >    
 > > If I am not mistaken, this excerpt is still present in the new
 > > (master) version of the manual.

 > I don't think so. I couldn't find it in the guide either.

That is strange.  I did the following:

git clone https://code.orgmode.org/bzg/org-mode.git

cd org-mode && make && make doc

From there, I don't know how to view the manual with Info (like I do
with the elpa version), but I had assumed it would be essentially the
same content as what is in the org.pdf file which is in the doc
directory.  There is indeed the absence of the old "Easy templates"
section, the new parts about the new insertion mechanism.  And the
above excerpt is also there (p.200).

I can also see the same excerpt in files org-manual.org and
org.texi...

Regards


-- 
EOST (École et Observatoire des Sciences de la Terre) 
IPG (Institut de Physique du Globe) | alain.cochard@unistra.fr
5 rue René Descartes   [bureau 106] | Phone: +33 (0)3 68 85 50 44 
F-67084 Strasbourg Cedex, France    | Fax:   +33 (0)3 68 85 01 25     

Re: ‘V’ ‘#+BEGIN_VERBATIM ... #+END_VERBATIM’ missing in manual(?)

[Nicolas Goaziou]

Hello,

Alain.Cochard@unistra.fr writes:

> That is strange.  I did the following:
>
> git clone https://code.orgmode.org/bzg/org-mode.git
>
> cd org-mode && make && make doc
>
> From there, I don't know how to view the manual with Info (like I do
> with the elpa version), but I had assumed it would be essentially the
> same content as what is in the org.pdf file which is in the doc
> directory.  There is indeed the absence of the old "Easy templates"
> section, the new parts about the new insertion mechanism.  And the
> above excerpt is also there (p.200).
>
> I can also see the same excerpt in files org-manual.org and
> org.texi...

I see it now. Fixed. Thank you.

Regards,

-- 
Nicolas Goaziou