usr_4[34].txt cosmetics

classic Classic list List threaded Threaded
6 messages Options
Reply | Threaded
Open this post in threaded view
|

usr_4[34].txt cosmetics

Florian Rehnisch

Hi folks,

it is said, that translators are the best profreaders.
Sometimes, I make annotations.  Let's see what I have:

# type: Plain text
#: usr_43.txt:61
# FIXME: ticks around maplocalleader, not dquotes, for it's an option
msgid ""
"Likewise, the mapping for \"\\c\" will disappear when editing another "
"buffer.  The \":map <buffer>\" command creates a mapping that is local to "
"the current buffer.  This works with any mapping command: \":map!\", "
"\":vmap\", etc.  The |<LocalLeader>| in the mapping is replaced with the "
"value of \"maplocalleader\"."

# type: Plain text
#: usr_44.txt:501
#, no-wrap
# FIXME shouldn't that be "C++ syntax"
msgid ""
"The \":runtime!\" command searches 'runtimepath' for all \"syntax/c.vim\" "
"files.\n"
"This makes the C syntax be defined like for C files.  If you have replaced "
                ~~~~~~~~ this one
"the\n"
"c.vim syntax file, or added items with an extra file, these will be loaded "
"as\n"
"well.\n"
"   After loading the C syntax items the specific C++ items can be defined.\n"
"For example, add keywords that are not used in C: >\n"

# type: Plain text
#: usr_44.txt:513
#, no-wrap
# FIXME s,It,A script,
msgid ""
"Now consider the Perl language.  It consists of two distinct parts: a\n"
"documentation section in POD format, and a program written in Perl itself.\n"
"The POD section starts with \"=head\" and ends with \"=cut\".\n"
"   You want to define the POD syntax in one file, and use it from the Perl\n"
"syntax file.  The \":syntax include\" command reads in a syntax file and "
"stores\n"
"the elements it defined in a syntax cluster.  For Perl, the statements are "
"as\n"
"follows: >\n"

# type: Plain text
#: usr_44.txt:668
# FIXME comma after b:current_syntax
msgid ""
"Choose a good, descriptive name for your syntax file.  Use lowercase letters "
"and digits.  Don't make it too long, it is used in many places: The name of "
"the syntax file \"name.vim\", 'filetype', b:current_syntax the start of each "
"syntax group (nameType, nameStatement, nameString, etc)."

Thanks and merry christmas,
 flori
--
vimhelp-de: http://www.florianrehnisch.de/vimhelp/


--~--~---------~--~----~------------~-------~--~----~
You received this message from the "vim_dev" maillist.
For more information, visit http://www.vim.org/maillist.php
-~----------~----~----~----~------~----~------~--~---

Reply | Threaded
Open this post in threaded view
|

Re: usr_4[34].txt cosmetics

Matt Wozniski-2

On Fri, Dec 26, 2008 at 6:49 AM, Florian Rehnisch wrote:

> Hi folks,
>
> it is said, that translators are the best profreaders.
                                            ^^^^
                                             ;-)

> Sometimes, I make annotations.  Let's see what I have:
>
> # type: Plain text
> #: usr_43.txt:61
> # FIXME: ticks around maplocalleader, not dquotes, for it's an option
> msgid ""
> "Likewise, the mapping for \"\\c\" will disappear when editing another "
> "buffer.  The \":map <buffer>\" command creates a mapping that is local to "
> "the current buffer.  This works with any mapping command: \":map!\", "
> "\":vmap\", etc.  The |<LocalLeader>| in the mapping is replaced with the "
> "value of \"maplocalleader\"."

I disagree with this - maplocalleader isn't an option, it's a variable.
'options' should be quoted in the vim help, and "variables" should be
double quoted.

> # type: Plain text
> #: usr_44.txt:501
> #, no-wrap
> # FIXME shouldn't that be "C++ syntax"
> msgid ""
> "The \":runtime!\" command searches 'runtimepath' for all \"syntax/c.vim\" "
> "files.\n"
> "This makes the C syntax be defined like for C files.  If you have replaced "
>                ~~~~~~~~ this one
> "the\n"
> "c.vim syntax file, or added items with an extra file, these will be loaded "
> "as\n"
> "well.\n"
> "   After loading the C syntax items the specific C++ items can be defined.\n"
> "For example, add keywords that are not used in C: >\n"

No, I think this one is right as well.  Though it could probably be
phrased slightly better, I believe it's trying to say that "All C syntax
items will be defined like for C files."  I'd suggest this patch as
a clarification:

diff --git a/doc/usr_44.txt b/doc/usr_44.txt
index f5506b4..e37bfd5 100644
--- a/doc/usr_44.txt
+++ b/doc/usr_44.txt
@@ -492,10 +492,10 @@ one for C by using the following command: >

  :runtime! syntax/c.vim

-The ":runtime!" command searches 'runtimepath' for all "syntax/c.vim" files.
-This makes the C syntax be defined like for C files.  If you have replaced the
-c.vim syntax file, or added items with an extra file, these will be loaded as
-well.
+The ":runtime!" command searches 'runtimepath' for all "syntax/c.vim" files
+and loads them each.  This makes every C syntax item be loaded just like they
+would for C files.  If you have replaced the c.vim syntax file, or added items
+with an extra file, these will be loaded as well.
    After loading the C syntax items the specific C++ items can be defined.
 For example, add keywords that are not used in C: >


> # type: Plain text
> #: usr_44.txt:513
> #, no-wrap
> # FIXME s,It,A script,
> msgid ""
> "Now consider the Perl language.  It consists of two distinct parts: a\n"
> "documentation section in POD format, and a program written in Perl itself.\n"
> "The POD section starts with \"=head\" and ends with \"=cut\".\n"
> "   You want to define the POD syntax in one file, and use it from the Perl\n"
> "syntax file.  The \":syntax include\" command reads in a syntax file and "
> "stores\n"
> "the elements it defined in a syntax cluster.  For Perl, the statements are "
> "as\n"
> "follows: >\n"

I agree here.

diff --git a/doc/usr_44.txt b/doc/usr_44.txt
index f5506b4..7aa324a 100644
--- a/doc/usr_44.txt
+++ b/doc/usr_44.txt
@@ -503,9 +503,10 @@ For example, add keywords that are not used in C: >

 This works just like in any other syntax file.

-Now consider the Perl language.  It consists of two distinct parts: a
-documentation section in POD format, and a program written in Perl itself.
-The POD section starts with "=head" and ends with "=cut".
+Now consider the Pere language.  There are two distinct types of files that
+need Perl syntax highlighting: a documentation section in POD format, and
+a program written in Perl itself.  The POD section starts with "=head" and
+ends with "=cut".
    You want to define the POD syntax in one file, and use it from the Perl
 syntax file.  The ":syntax include" command reads in a syntax file and stores
 the elements it defined in a syntax cluster.  For Perl, the statements are as

> # type: Plain text
> #: usr_44.txt:668
> # FIXME comma after b:current_syntax
> msgid ""
> "Choose a good, descriptive name for your syntax file.  Use lowercase letters "
> "and digits.  Don't make it too long, it is used in many places: The name of "
> "the syntax file \"name.vim\", 'filetype', b:current_syntax the start of each "
> "syntax group (nameType, nameStatement, nameString, etc)."

Yep.

diff --git a/doc/usr_44.txt b/doc/usr_44.txt
index f5506b4..d6609f9 100644
--- a/doc/usr_44.txt
+++ b/doc/usr_44.txt
@@ -663,7 +663,7 @@ as an example will save you a lot of time.

 Choose a good, descriptive name for your syntax file.  Use lowercase letters
 and digits.  Don't make it too long, it is used in many places: The name of
-the syntax file "name.vim", 'filetype', b:current_syntax the start of each
+the syntax file "name.vim", 'filetype', b:current_syntax, the start of each
 syntax group (nameType, nameStatement, nameString, etc).

 Start with a check for "b:current_syntax".  If it is defined, some other

> Thanks and merry christmas,
>  flori

Hope the patches make things a little easier for you, Bram.  :-)

~Matt

--~--~---------~--~----~------------~-------~--~----~
You received this message from the "vim_dev" maillist.
For more information, visit http://www.vim.org/maillist.php
-~----------~----~----~----~------~----~------~--~---

Reply | Threaded
Open this post in threaded view
|

Re: usr_4[34].txt cosmetics

Lech Lorens

Dnia 26-12-2008 Matt Wozniski <[hidden email]> pisze:

>
> diff --git a/doc/usr_44.txt b/doc/usr_44.txt
> index f5506b4..7aa324a 100644
> --- a/doc/usr_44.txt
> +++ b/doc/usr_44.txt
> @@ -503,9 +503,10 @@ For example, add keywords that are not used in C: >
>
>  This works just like in any other syntax file.
>
> -Now consider the Perl language.  It consists of two distinct parts: a
> -documentation section in POD format, and a program written in Perl itself.
> -The POD section starts with "=head" and ends with "=cut".
> +Now consider the Pere language.  There are two distinct types of files that
> +need Perl syntax highlighting: a documentation section in POD format, and
> +a program written in Perl itself.  The POD section starts with "=head" and
> +ends with "=cut".
>     You want to define the POD syntax in one file, and use it from the Perl
>  syntax file.  The ":syntax include" command reads in a syntax file and stores
>  the elements it defined in a syntax cluster.  For Perl, the statements are as

Typo: Perl, not Pere:


diff --git a/doc/usr_44.txt b/doc/usr_44.txt
index f5506b4..7aa324a 100644
--- a/doc/usr_44.txt
+++ b/doc/usr_44.txt
@@ -503,9 +503,10 @@ For example, add keywords that are not used in C: >

 This works just like in any other syntax file.

-Now consider the Perl language.  It consists of two distinct parts: a
-documentation section in POD format, and a program written in Perl itself.
-The POD section starts with "=head" and ends with "=cut".
+Now consider the Perl language.  There are two distinct types of files that
+need Perl syntax highlighting: a documentation section in POD format, and
+a program written in Perl itself.  The POD section starts with "=head" and
+ends with "=cut".
    You want to define the POD syntax in one file, and use it from the Perl
 syntax file.  The ":syntax include" command reads in a syntax file and stores
 the elements it defined in a syntax cluster.  For Perl, the statements are as

--
Cheers,
Lech

--~--~---------~--~----~------------~-------~--~----~
You received this message from the "vim_dev" maillist.
For more information, visit http://www.vim.org/maillist.php
-~----------~----~----~----~------~----~------~--~---

Reply | Threaded
Open this post in threaded view
|

Re: usr_4[34].txt cosmetics

Florian Rehnisch
In reply to this post by Matt Wozniski-2

o Matt Wozniski <[hidden email]>:
> On Fri, Dec 26, 2008 at 6:49 AM, Florian Rehnisch wrote:

>> Hi folks,
>>
>> it is said, that translators are the best profreaders.
>                                            ^^^^
>                                             ;-)

Ah well, sorry for that.  I'm non-native ...

>> # type: Plain text
>> #: usr_43.txt:61
>> # FIXME: ticks around maplocalleader, not dquotes, for it's an option
>> msgid ""
>> "Likewise, the mapping for \"\\c\" will disappear when editing another "
>> "buffer.  The \":map <buffer>\" command creates a mapping that is local to "
>> "the current buffer.  This works with any mapping command: \":map!\", "
>> "\":vmap\", etc.  The |<LocalLeader>| in the mapping is replaced with the "
>> "value of \"maplocalleader\"."

> I disagree with this - maplocalleader isn't an option, it's a variable.
> 'options' should be quoted in the vim help, and "variables" should be
> double quoted.

Ah, I see.  Learning by errors.  So why not state it's a variable,
like this:

#v+
--- usr_43.txt 2008-08-11 21:35:03.000000000 +0200
+++ eix/usr_43.txt 2008-12-28 12:23:59.000000000 +0100
@@ -57,7 +57,8 @@
 Likewise, the mapping for "\c" will disappear when editing another buffer.
 The ":map <buffer>" command creates a mapping that is local to the current
 buffer.  This works with any mapping command: ":map!", ":vmap", etc.  The
-|<LocalLeader>| in the mapping is replaced with the value of "maplocalleader".
+|<LocalLeader>| in the mapping is replaced with the value of the variable
+"maplocalleader".
 
 You can find examples for filetype plugins in this directory: >
#v-

 flori
--
http://www.florianrehnisch.de/vimhelp/


--~--~---------~--~----~------------~-------~--~----~
You received this message from the "vim_dev" maillist.
For more information, visit http://www.vim.org/maillist.php
-~----------~----~----~----~------~----~------~--~---

Reply | Threaded
Open this post in threaded view
|

Re: usr_4[34].txt cosmetics

Tony Mechelynck

On 28/12/08 12:31, Florian Rehnisch wrote:

> o Matt Wozniski<[hidden email]>:
>> On Fri, Dec 26, 2008 at 6:49 AM, Florian Rehnisch wrote:
>
>>> Hi folks,
>>>
>>> it is said, that translators are the best profreaders.
>>                                             ^^^^
>>                                              ;-)
>
> Ah well, sorry for that.  I'm non-native ...
>
>>> # type: Plain text
>>> #: usr_43.txt:61
>>> # FIXME: ticks around maplocalleader, not dquotes, for it's an option
>>> msgid ""
>>> "Likewise, the mapping for \"\\c\" will disappear when editing another"
>>> "buffer.  The \":map<buffer>\" command creates a mapping that is local to "
>>> "the current buffer.  This works with any mapping command: \":map!\","
>>> "\":vmap\", etc.  The |<LocalLeader>| in the mapping is replaced with the "
>>> "value of \"maplocalleader\"."
>
>> I disagree with this - maplocalleader isn't an option, it's a variable.
>> 'options' should be quoted in the vim help, and "variables" should be
>> double quoted.
>
> Ah, I see.  Learning by errors.  So why not state it's a variable,
> like this:
>
> #v+
> --- usr_43.txt 2008-08-11 21:35:03.000000000 +0200
> +++ eix/usr_43.txt 2008-12-28 12:23:59.000000000 +0100
> @@ -57,7 +57,8 @@
>   Likewise, the mapping for "\c" will disappear when editing another buffer.
>   The ":map<buffer>" command creates a mapping that is local to the current
>   buffer.  This works with any mapping command: ":map!", ":vmap", etc.  The
> -|<LocalLeader>| in the mapping is replaced with the value of "maplocalleader".
> +|<LocalLeader>| in the mapping is replaced with the value of the variable
> +"maplocalleader".
>
>   You can find examples for filetype plugins in this directory:>
> #v-
>
>   flori

That's implicit. Options (used with :set) are shown within single
quotes, ex-commands prefixed by a colon, functions followed by
parentheses, etc. This help paragraph speaks about the value of
"maplocalleader", another one might talk about "version" or
"colors_name", etc. All these are variables or constants.

Best regards,
Tony.
--
There was a plane crash over mid-ocean, and only three survivors were
left in the life-raft: the Pope, the President, and Mayor Daley.
Unfortunately, it was a one-man life-raft, and quickly sinking, so they
started debating who should be allowed to stay.

The Pope pointed out that he was the spiritual leader of millions all
over the world, the President explained that if he died then America
would be stuck with the Vice-President, and so forth.  Then Mayor Daley
said, "Look!  We're not solving anything like this!  The only fair
thing to do is to vote on it."  So they did, and Mayor Daley won by 97
votes.

--~--~---------~--~----~------------~-------~--~----~
You received this message from the "vim_dev" maillist.
For more information, visit http://www.vim.org/maillist.php
-~----------~----~----~----~------~----~------~--~---

Reply | Threaded
Open this post in threaded view
|

Re: usr_4[34].txt cosmetics

Bram Moolenaar
In reply to this post by Florian Rehnisch


Florian Rehnisch wrote:

> it is said, that translators are the best profreaders.
> Sometimes, I make annotations.  Let's see what I have:

Thanks, I've changed the referred text a bit.

--
Communication is one of the most compli..., eh, well, it's hard.
You know what I mean.  Not?

 /// Bram Moolenaar -- [hidden email] -- http://www.Moolenaar.net   \\\
///        sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ \\\
\\\        download, build and distribute -- http://www.A-A-P.org        ///
 \\\            help me help AIDS victims -- http://ICCF-Holland.org    ///

--~--~---------~--~----~------------~-------~--~----~
You received this message from the "vim_dev" maillist.
For more information, visit http://www.vim.org/maillist.php
-~----------~----~----~----~------~----~------~--~---