Copy editing guideline for this issue

Check that the term drop down is used correctly and consistently

We have been using the the term dropdown for both dropdown buttons and select lists.

We should use the term select list for select lists (lists of choices in an HTML "select" tag, such as what you would see when you select a language to add or the default country).

We should use the term dropdown button (not drop-down or drop down) for buttons that contain lists of links, such as what you would see in an Operations section of the Content form at admin/content.

Task Instructions

  1. To claim this task, assign this issue to yourself (see instructions below). Only claim a task if you can complete it in about two weeks.
  2. See the instructions below to "clone" the guide, edit the entire user guide so that it follows the above copy editing guideline, and make a patch file. Do not make other edits at this time -- other edits will be taken care of in other issues. If you find that you cannot complete the whole task, but have made some progress, make a patch file for the part you've done.
  3. Upload the patch file to this issue, in the Files section.
  4. Set the Issue Status to Needs Review, in the Issue Metadata section.
  5. Write a comment stating what you've done.
  6. In this comment, add "Attribution" information 
    https://www.drupal.org/u/msmith[Mary Smith]
or
https://www.drupal.org/u/jsmith[Joe Smith] of https://example.com[Example Company]
  7. Someone will review your work, and either accept it, or set it back to Needs Work for more attention.
  8. If the status is set to Needs Work, make the requested changes, make a new patch file, and upload it. Iterate until it is fixed.

Detailed Instructions for Assigning Issues and Patching

Assigning an issue to yourself

  1. Scroll to the bottom of the issue to Add new comment.
  2. Open the "Issue metadata" section if it is collapsed.
  3. Put your user name in the "Assigned" field, add a short comment stating that you are claiming the task, and Save.

Editing and making a patch file

  1. In order to make a patch file, you will need to use the Git version control software. There are generic instructions on Git at: https://www.drupal.org/documentation/git/ -- if you have never used Git, you will probably want to read the introductory material, and you'll need to install Git.
  2. Specific Git instructions for the User Guide project can be found at https://www.drupal.org/project/user_guide/git-instructions . Follow the instructions to "clone" the repository (see the "One-time only" instructions).
  3. Make the edits for this issue, using a plain-text editor. The source files are located in the source/en subdirectory, and have extension .txt, and are in AsciiDoc format (see below).
  4. Go back to the specific Git instructions page and follow the instructions there to make a patch file. There are also more detailed git patch instructions in the Git documentation section linked above.

AsciiDoc formatting

The documentation in this project is formatted using AsciiDoc. The Formatting page in the User Guide guidelines (login: drupal / drupal ) has links and details for how to format text properly, make cross-links between topics, etc.

CommentFileSizeAuthor
#12 2703223-user_guide-drop_down_final-12.patch12.66 KBcleverington
#10 2703223-user_guide-dropdown-10.patch8.65 KBcleverington
#8 2703223-user_guide-dropdown-button-8.patch9.82 KBcleverington

Comments

batigolix created an issue. See original summary.

batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Issue summary: View changes
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Issue summary: View changes
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented
Status: Needs review » Active
batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented

We should decide on the spelling of dropdown, vs drop-down vs drop down

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Let's go with "dropdown" as you suggest, even though my spellchecker in Firefox says it is wrong. Thanks for filing this issue!

cleverington’s picture

cleverington commented
Assigned: Unassigned » cleverington
cleverington’s picture

cleverington commented
Status: Active » Needs review
StatusFileSize
new 2703223-user_guide-dropdown-button-8.patch9.82 KB

Corrections made. No readability issues or verbiage considerations on this set as it was edit-in-place changes.

  • Completed:
    • drop-down
    • drop down
    • Drop-Down
    • drop-Down
    • Drop Down
    • drop Down
    • Drop down

Comment update - 2016-04-10:

Edited by https://www.drupal.org/u/cleverington[Charles Leverington]

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes
Status: Needs review » Needs work

Thanks for the patch!

However, I think that the issue summary for this issue was not clear enough, sorry! I have just updated it.

We want to use "dropdown button" for buttons that contain lists of links, such as what you would see in an Operations section of the Content form at admin/content.

We want to use "select list" for a list of choices (an HTML select element), such as what you would see when you select a language to add or the default country.

cleverington’s picture

cleverington commented
Status: Needs work » Needs review
StatusFileSize
new 2703223-user_guide-dropdown-10.patch8.65 KB

Made a bunch of edits and updated the patch for the newest revisions (which, awesomely, removed a lot of work....)

Should be good.

jhodgdon’s picture

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

Thanks -- this is better! I think it still needs some work though:

  1. +++ b/source/en/language-content-config.txt
@@ -34,13 +34,14 @@ image:images/language-content-config_custom.png["Custom language settings, conte
+you can choose (via their dropdown button) whether the sub-types (for example

    This is a select list not a dropdown button. 

  2. +++ b/source/en/structure-content-display.txt
@@ -37,11 +37,11 @@ image:images/structure-content-display_initial_output.png["screen capture of
 . In the _Manage_ administrative menu, navigate to _Structure_ > _Content
-types_ (_admin/structure/types_). Then select the _Manage display_ drop down
+types_ (_admin/structure/types_). Then select the _Manage display_ select list
 for _Vendor_ content type.
 +

    Actually this instruction should be something like:

    ... click _Manage display_ in the drop-down button for the _Vendor_ content type.

    It's definitely a drop-down button, not a select list, and we definitely want to say 'click' not 'select'. 

  3. +++ b/source/en/structure-content-display.txt
@@ -37,11 +37,11 @@ image:images/structure-content-display_initial_output.png["screen capture of
-// select the _Manage fields_ drop down for _Vendor_ content type.
+// select the _Manage fields_ select list for _Vendor_ content type.

    This was actually correct before, and we don't really need to change comment lines starting with // anyway. 

  4. +++ b/source/en/structure-fields.txt
@@ -24,8 +24,8 @@ The website needs a _Vendor_ content type. See <<structure-content-type>>.
 . In the _Manage_ administrative menu, navigate to _Structure_ > _Content
-types_ (_admin/structure/types_). Then select the _Manage fields_ drop down
-for _Vendor_ content type. The _Manage fields_ page appears.
+types_ (_admin/structure/types_). Then select the _Manage fields_ dropdown
+button for the _Vendor_ content type. The _Manage fields_ page appears.

    See above. This is a drop-down button, and we want to click, not select. 

  5. +++ b/source/en/structure-form-editing.txt
@@ -25,8 +25,9 @@ with an _Ingredients_ taxonomy term reference field (see
 . In the _Manage_ administrative menu, navigate to _Structure_ > _Content
-types_ (_admin/structure/types_). Then click _Manage form display_ drop-down
-for _Recipe_ content type. The _Manage form display_ page appears.
+types_ (_admin/structure/types_). Then click _Manage form display_  on the
+dropdown button for the _Recipe_ content type. The _Manage form display_ page
+appears.

    This is better wording! Maybe use this as the template for the other ones? 

  6. +++ b/source/en/user-permissions.txt
@@ -28,7 +28,7 @@ The site needs to have a _Vendor_ role. See <<user-roles>>.
-. Click _Edit permissions_ in the drop-down list for the _Vendor_
+. Click _Edit permissions_ in the select list for the _Vendor_
 role. The _Edit role_ page appears where you show can see all the available

    This is a drop-down list actually.

    Anything with links you can click is a drop-down list.

    A select list is a list of choices that is embedded in a form, and after you select an option, nothing happens until you submit a form. 

  7. +++ b/source/en/views-block.txt
@@ -37,8 +37,8 @@ pencil icon, then click _Edit view_.
+. Click on _Add_ in the Displays section and select _Block_ from the dropdown
+button. The new display is created, we are automatically switched to its

    select -> click

cleverington’s picture

cleverington commented
Status: Needs work » Needs review
StatusFileSize
new 2703223-user_guide-drop_down_final-12.patch12.66 KB

Made the changes recommended and found a few extra additions of "drop down" added since the last patch.

We may need to redo this particular search "one last time" once the guide is ready for the community at-large. Just by your own comments in #11, not everybody has down the 'dropdown' versus 'drop down' copy-edit rule (or even really knows about it... lol).

Cheers!

  • jhodgdon committed 06f5141 on 8.x-0.x 
    Issue #2703223 by cleverington, jhodgdon: Copy edit: Dropdown (button)...
jhodgdon’s picture

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

Yes... These issues are a "first pass" at getting some problems addressed guide-wide. The whole guide will also need generic copy editing and proofreading, which will include a final check that it adheres to all of our style guidelines.

Anyway, let's see about this patch. Looks mostly excellent! I went through it carefully and found a couple of additional places where selects and drop-downs were confused, fixed them, and committed it. (Some were left over from #2698977: Copy edit: Click, Select and Check and not caught there.)

Thanks!

Status: Fixed » Closed (fixed)

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