Note: For guidelines and instructions pages linked below, log in with user name / password: drupal/drupal.

Task for this issue

Copy edit the following topic:

Title: Glossary
Section: Glossary
File name: glossary.txt

Look for:
- Typographical errors
- Spelling errors
- Grammar and usage errors
- Punctuation problems
- Formatting problems in the output. The User guide output can be found on: https://userguide_new-drupal.dev.devdrupal.org/d8guide/en/index.html (access: drupal / drupal )
Note: On other copy editing issues, we have asked to check for adherence to guidelines, but the Glossary is a special case. So in this case, it's just the above (typos, formatting, etc.). Thanks!
Also, be careful when making a patch or update for this file! The AsciiDoc formatting is very sensitive and a bit strange for the Glossary.

Note that the "single-issue" guidelines in the Editing guidelines page, as well as the entire Writing guidelines page, should have already been enforced. But it is still a good idea to at least check them quickly.

Instructions

See https://userguide_new-drupal.dev.devdrupal.org/guidelines/instructions.h... -- but skip the section on finding a task to do, since you have selected this one.

Checklist for this task

- Is a patch file provided? If only one or a few topics were edited, you can instead attach the updated source file(s).
- Is the edit complete and correct?
- Is the work free from additional edits outside the scope of the provided guidelines or task?
- Is attribution provided? See https://userguide_new-drupal.dev.devdrupal.org/guidelines/guidelines.htm...

CommentFileSizeAuthor
#16 2754591-add-some-suggestions-16.patch2.64 KBbaluertl
#12 user_guide-glossary-2754591-12.patch6.15 KBjojyja
#8 user_guide-glossary-2754591-8.patch5.95 KBjojyja
#3 copy_edit_glossary_txt-2754591-3.patch645 bytesswarad07

Comments

jhodgdon created an issue. See original summary.

swarad07’s picture

swarad07
Primary language English
Location Navi Mumbai, India
commented
Assigned: Unassigned » swarad07
swarad07’s picture

swarad07
Primary language English
Location Navi Mumbai, India
commented
Assigned: swarad07 » Unassigned
Status: Active » Needs review
StatusFileSize
new copy_edit_glossary_txt-2754591-3.patch645 bytes

Hi jhodgdon ,

I went through the entire file, everything is fine. I just found one small thing, all full form of acronyms are written in italics, except for WYSIWYG. Maybe it is fine the way it is but attaching a patch in case you feel we should change it for consistency.

swarad07’s picture

swarad07
Primary language English
Location Navi Mumbai, India
commented

Written and edited by https://www.drupal.org/u/swarad07[Swarad Mokal] of http://www.blisstering.com[Blisstering Solutions]

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Fixed

Good catch! The change looks good to me. Thanks for checking that file over!

Committed to the guide, and your attribution has already been added to the "overall copy editing" section at the top of attributions.txt. (If you edit a particular topic's wording, more than a word here and there, we'll also add you to the attributions of that particular topic. For small changes, we're adding people to the "overall guide" section at the top.)

jojyja’s picture

jojyja commented
Assigned: Unassigned » jojyja
Status: Fixed » Active
jojyja’s picture

jojyja commented
Assigned: jojyja » Unassigned
Status: Active » Needs review
StatusFileSize
new user_guide-glossary-2754591-8.patch5.95 KB

I looked this topic over again and actually found several things that I thought needed fixing. Here's a patch.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Thanks for making another pass at this one @jojyja!

These edits all look excellent, with three exceptions:

  1. +++ b/source/en/glossary.txt
@@ -43,12 +43,12 @@
-   such as the name of your site, the content types and views you
+   such as the name of your site, the <<Content type,content types>> and <<View, views>> you

    This change is not going to work.

    In order to link to a glossary topic, you have to figure out the machine name of the entry. This is in square brackets, something like
    [[glossary-content-type]]

    Please read section 1.2.4 on making cross-links on:
    https://userguide_new-drupal.dev.devdrupal.org/guidelines/formatting.html

  2. +++ b/source/en/glossary.txt
@@ -189,9 +189,8 @@
-(((Linux Apache MySQL PHP (LAMP),definition))

    This is an index entry. We do not want it removed. 

  3. +++ b/source/en/glossary.txt
@@ -342,14 +341,15 @@
+(((Vocabulary,definition)))
+[[glossary-widget]] Widget::

    This edit is adding an index entry saying "Vocabulary, definition" before the glossary entry for Widget. Should be
    (((Widget,definition)))
    perhaps?

jojyja’s picture

jojyja commented

Hi! Thanks for the feedback! I will work on them.

I'm slightly confused about #2. The line "(((Linux Apache MySQL PHP (LAMP),definition))" appears in the User Guide's front end just after Image style. Glossary.txt has another line "(((LAMP (Linux Apache MySQL PHP),definition)))" defined. So should I be retaining both?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Ah, good question.

Hm.

So lines like

(((Linux Apache MySQL PHP (LAMP),definition))

are index entries, and they come just before the corresponding glossary entry... OH, I see the problem. That line in the User Guide is missing the ending ) -- we need three ))) in a row, and there are only two at the end of that line.

So, that is how that line should be fixed. Oops! This is why we need someone to carefully copy edit, looking at the output as well as the source text file. :) THANKS!

jojyja’s picture

jojyja commented
Status: Needs work » Needs review
StatusFileSize
new user_guide-glossary-2754591-12.patch6.15 KB

I have attached a patch featuring updates based on your feedback.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Fixed

Looks perfect, thanks! Committed.

  • jhodgdon committed 69a31ec on 8.x-0.x authored by jojyja 
    Issue #2754591 by jojyja: Copy edit glossary.txt

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

baluertl’s picture

baluertl
he/him
Primary language Hungarian
Location Budapest 🇪🇺
commented
Status: Closed (fixed) » Needs review
StatusFileSize
new 2754591-add-some-suggestions-16.patch2.64 KB

During the translation of glossary.txt I came up with the idea of some suggestions. Although a patch is provided, but here's a list for easier review and discussion:

  • At the term of Entity type (at line 145) there's a link <<glossary-content-type,content items>> saying other than where it points. (The topic of entities, entity types and subtypes, fields and bundles, etc. is a though one, needs extra caution of what sentence what expression refers to exactly.)
  • Wherever a path alias is mentioned, we could prefix them with a slash before to make more sense. For example at the term of Alias (line 17-18)
  • At the term of Anonymous the "user" in parenthesis relates to the noun of person more, so I'd suggest to move a couple of words earlier.
  • Beside the simple "Bundle" we may create a "Field bundle" term too, as it's also referred frequently within the context of fields. (Pointing to the same location, <<glossary-entity-subtype,Entity subtype>>.) Just like as we did the same with "Formatter" and "Field Formatter" pair of terms.
  • At the term of Content Management System the link text is in italic, however it's not common at the others.
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Fixed

Let's open up a new issue for this please, rather than going back to this old issue?

baluertl’s picture

baluertl
he/him
Primary language Hungarian
Location Budapest 🇪🇺
commented

Alright, here we go: #2828339: Minor improvements for glossary.txt

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.