Documentation Team: 'Doc IRC meeting: Feb 19' at groups.drupal.org

[Addison Berry]

add1sun has posted a Event at http://groups.drupal.org/node/19111
Doc IRC meeting: Feb 19
---------------
Zee Doodle has spoken. We'll meet on Thursday, Feb. 19 from 2 - 3
p.m. EST (19:00 GMT, 11 a.m. PST) for one hour in the #drupal-docs
IRC channel on Freenode.
Mark Boulton gave us an editorial guide for the redesign that is
just around the corner (like within a month or so). The editorial
guide covers all of the text on D.o so we need to review it, discuss
and decide the best course of action to implement it. You can read
the guide here: http://infrastructure.drupal.org/drupal.org-style-guide/editorial.html
. Please talk about this and ask questions on the mailing list
prior to the IRC meeting to hash things out. This will be a major
task for us to tackle in the coming months (maybe even a Drupalcon
sprint project / March doc challenge) so let's hammer on it a bit
and be ready.

--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/

[Emma Jane Hogbin]

Mark Boulton gave us an editorial guide for the redesign that is
just around the corner (like within a month or so). The editorial
guide covers all of the text on D.o so we need to review it, discuss
and decide the best course of action to implement it. You can read
the guide here: http://infrastructure.drupal.org/drupal.org-style-guide/editorial.html

I won't be able to make it to the meeting, but here are a few comments
from me:

Overall it looks excellent! i have a few points of disagreement which
I've noted below.

1. e-mail, not email
I disagree (there are a few e-word examples). I think common usage omits
the hyphen. Although our own e-Commerce module follows none of the right
rules. :)

2. With the use of the word "web" these three items seems inconsistent:
# website or site, not web-site or web site
# homepage, not home page
# web page

I personally use: Web (with a cap) plus whatever it is. For example: Web
site; Web page. It seems odd that "website" is one word but "web page"
is two.


3. Don't use double hyphens; use the HTML entity.
And then about ten paragraphs later they use a double dash instead of
the HTML entity. Realistically I think there are very few who will take
the time to memorize the entity (I know I wimp out and use the double dash).



regards,
emma

[Andreas Haugstrup Pedersen]

Post by Emma Jane Hogbin
# website or site, not web-site or web site
# homepage, not home page
# web page
I personally use: Web (with a cap) plus whatever it is. For example: Web
site; Web page. It seems odd that "website" is one word but "web page"
is two.

Compound nouns in English are massively confusing (at least to this
non-native speaker). Cowboy and cornflakes, but laser pistol and flux
capacitor. Trust the dictionary and it says website and web page (no
caps). It sounds odd, but language usually is.

Post by Emma Jane Hogbin
3. Don't use double hyphens; use the HTML entity.
And then about ten paragraphs later they use a double dash instead of
the HTML entity. Realistically I think there are very few who will take
the time to memorize the entity (I know I wimp out and use the double dash).

I'm in the camp is supporting "correct" (traditional?) typography because
it aids reading and skimming. At the same time people are generally lazy.
Would something like http://drupal.org/project/typogrify assist in
automatically converting lazy typing into proper typography?

Today's productivity tip: On a mac you can write an em dash by hitting
Shift+Option+- like so: —
More here:
http://tlt.its.psu.edu/suggestions/international/accents/codemac.html

[Addison Berry]

Post by Andreas Haugstrup Pedersen

Post by Emma Jane Hogbin
3. Don't use double hyphens; use the HTML entity.
And then about ten paragraphs later they use a double dash instead of
the HTML entity. Realistically I think there are very few who will take
the time to memorize the entity (I know I wimp out and use the double dash).

I'm in the camp is supporting "correct" (traditional?) typography because
it aids reading and skimming. At the same time people are generally lazy.
Would something like http://drupal.org/project/typogrify assist in
automatically converting lazy typing into proper typography?

We are only going to use HTML entities if there is a filter to handle
it. There is no way that we can maintain having thousands of people
always type in entities by hand. I've never used Typogrify myself but
definitely something to give a spin and get an infra review on. Thanks
for pointing that out. I've created a webmasters redesign issue for
it: http://drupal.org/node/376244

- Addi
--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/

[Nancy Wichmann]

Emma Jane Hogbin wrote:
1. e-mail, not email
I agree with this one. The "e" is a qualifier rather than part of the word.

2. With the use of the word "web" these three items seems inconsistent:
# website or site, not web-site or web site
# homepage, not home page
# web page
Again, I see "web" and "home" as qualifiers, so they should be separated. In
these cases, they serve as adjectives, so the hyphen should not be present
(as opposed the "e" above). So I would write "web site," "home page," and
"web page." [BTW, another common mistake, not that punctuation properly goes
inside the quotes.]

The common spell-checkers will tell you "Internet" and "web." I have never
understood this; I suspect it is an anachronism. I personally believe it
should depend upon usage. When used as a proper noun, the should be
capitalized, otherwise not. "The Web is a wonderful thing." "My internet
programming skills could be better."

Nancy E. Wichmann, PMP
Injustice anywhere is a threat to justice everywhere. - Martin L. King, Jr.

[Addison Berry]

Just a reminder for folks to attend today's IRC meeting. Starts in
approximately 3.5 hours in #drupal-docs.

Date: February 12, 2009 9:02:45 PM EST
Feb 19' at groups.drupal.org

add1sun has posted a Event at http://groups.drupal.org/node/19111
Doc IRC meeting: Feb 19
---------------
Zee Doodle has spoken. We'll meet on Thursday, Feb. 19 from 2 - 3
p.m. EST (19:00 GMT, 11 a.m. PST) for one hour in the #drupal-docs
IRC channel on Freenode.
Mark Boulton gave us an editorial guide for the redesign that is
just around the corner (like within a month or so). The editorial
guide covers all of the text on D.o so we need to review it, discuss
and decide the best course of action to implement it. You can read
the guide here: http://infrastructure.drupal.org/drupal.org-style-guide/editorial.html
. Please talk about this and ask questions on the mailing list
prior to the IRC meeting to hash things out. This will be a major
task for us to tackle in the coming months (maybe even a Drupalcon
sprint project / March doc challenge) so let's hammer on it a bit
and be ready.

--
Pending work: http://drupal.org/project/issues/documentation/
List archives: http://lists.drupal.org/pipermail/documentation/