Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Copy editing guideline for this issue
- When providing instructions to click on a link or button, use the phrase “Click (link text)” - not “click on” or “select” or other terms.
- For a drop-down list or radio button, say “Select (choice)”.
- For a checkbox, say “Check (choice)”.
- Instead of using using Choose, say Select, Click of Check.
Make sure that the actual UI text you are selecting or clicking on is in italics.
Task Instructions
- 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.
- 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.
- Upload the patch file to this issue, in the Files section.
- Set the Issue Status to Needs Review, in the Issue Metadata section.
- Write a comment stating what you've done.
- 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]
- Someone will review your work, and either accept it, or set it back to Needs Work for more attention.
- 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
- Scroll to the bottom of the issue to Add new comment.
- Open the "Issue metadata" section if it is collapsed.
- 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
- 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.
- 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).
- 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).
- 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.
Comment | File | Size | Author |
---|---|---|---|
#20 | interdiff-2698977-18-20.txt | 9.75 KB | ifrik |
#20 | 2698977-20.patch | 48.38 KB | ifrik |
#18 | interdiff-2698977-12-18.txt | 12.75 KB | ifrik |
#18 | 2698977-18.patch | 47.96 KB | ifrik |
#12 | interdiff-2698977-8-12.txt | 26.79 KB | ifrik |
Comments
Comment #2
ifrikComment #3
batigolixmine!
Comment #4
batigolixComment #5
jhodgdonDoh! :)
Comment #6
jhodgdonI've now centralized instructions for the editing tasks. I'll go ahead and leave the instructions on these issues, but you can also go to
https://userguide_new-drupal.dev.devdrupal.org/guidelines/instructions.h...
(log in with drupal / drupal)
and follow the instructions there (probably more complete).
Comment #7
batigolixComment #8
batigolixJennifer: I am also looking for occurences of "Choose". Should I add that to the guidelines?
Comment #9
batigolixFind attached a patch
Attribution info
https://www.drupal.org/u/batigolix[Boris Doesborg]
Comment #10
ifrikThanks batigolix,
there are no instance of "choose" used in relation to links, radio buttons, drop-down menu and check boxes.
But there are quite a few instances of click, select and check that are followed by the link text in double quotes or reference to "button".
Comment #11
ifrikI'll continue on this one.
Comment #12
ifrikI've checked for instanced of click, select and change and edited them where appropriate.
There are some left where general editing should take care of them, for example when in phrases like "click the pencil icon" etc.
Where the terms are used they are followed by the link label or option in italics instead of in quotation marks or so.
Comment #13
jhodgdonWhew, that's a big patch, thanks!! I reviewed it carefully and have a few suggestions.
Most of them are about drop-down lists of operations buttons. These are actually links organized into button drop-downs, so I think we should say "click" for them.
Also, many of these buttons/links are duplicated throughout the page (such as the operations on each content item row in the admin/content page or the user accounts on admin/people). I saw one really good example in this patch of how to describe this:
Let's standardize on that sort of style for when we have to say this.
The link text actually does have a + sign in it.
This is in a comment, so we don't need _Save_ to be in italics.
I don't know about this one. The "choose file" button is provided by the browser, not by Drupal, and for instance Firefox says "Browse" on it, not "Choose file".
So, I think we should change this whole section to say something like:
Under _Upload logo image_, upload the logo file.
"Enable the checkbox" should be updated for this issue.
This is a radio button. It should say "select".
Maybe
Click the name of the field...
?
Just right clicking is not enough to copy the address. You have to right click and then select Copy link address.
This is also browser-dependent, and what do you do on Mobile? No way to right-click on a phone.
So... we may need to change these instructions.
The + sign is part of the button text I think?
Hm. This is actually clicking on a link in a drop-down button, so I think we should say "click" not "select"?
Hm. This is kind of a navigation instruction within the page.
Maybe something like:
Find the _Displays_ > _Master.... > _Exposed form_ > _Reset options_ section.
rewrap to 80... also there are lots of "edit menu" buttons on the screen and we lost the information that we want to click just that specific one. Is that the right text for the button anyway?
Again this is a drop-down list of links, not a select list, so I think we should use the word "click".
This change is out of scope, and also incorrect. We have a separate issue.
click not select
This is a comment.
Either leave it as one long line, or add a // to the beginning of the second line. The change here will make some of the text of the comment visible.
click not select
There is a + in the button label I think? don't remove that...
select -> click
Line too long.
click not select
no "the" after "Click" at the start of this line
Select -> Click
Select -> Click
Select -> Click
select => click
select -> click
Comment #14
jhodgdonAlso found this when grepping on another issue:
source/en/language-content-config.txt:. In the Custom language settings enable _Content_, _Custom block_ and _Custom
these are checkboxes.
Comment #15
ifrikThanks for reviewing this. I'm all in favour for consistency so I'm happy to work on this further.
About the "+ Add something": As far as I'm aware the "+" is added by the theme layer. I'll check that but if it's not part of the actual UI text, then I would rather leave it out.
Comment #16
jhodgdonAh, yes you are correct! That is actually in the theme layer and not in the UI text. I had no idea. So yes, let's take those + signs out.
Comment #17
ifrikRerolling.
Comment #18
ifrikThanks, I rerolled the patch and then edited it according to comment 13-18.
Comment #19
jhodgdonPhew! Big patch. Thanks!
Getting better... I think we still need to fix some things though:
This was a comment line. To break it up to 80 character lines, you need to add // at the start of the added lines. Otherwise the text will appear in the output.
Select -> Click (this is a button/link).
Nicely compacted! :)
We actually want to call this a "dropdown button" here (which is the subject of another issue: #2703223: Copy edit: Dropdown (button)). But "click" is correct.
This is a good way to express what needs to be done!
clicking on -> clicking
Hm... I think if we're saying "its" (which I think we need), we need to say button or link, something like:
... by clicking _Edit menu_ from its _Operations_ dropdown button...
???
Also this needs to be rewrapped to 80 character lines.
I think Add field is a button? Should be Click.
Do not change this comment, or if you do and decide to rewrap, the second line still needs to start with //
This is a link in a drop-down list, so we want to "click" it.
This may still be misleading.
They need to change where it says "All displays" in a Select list, to saying "For this block only".
So this is a Select operation?
This still seems a bit garbled.
choose -> select
Select -> Click
I think this is a link to click on, not an option to select?
choose -> select
Comment #20
ifrikThanks.
I hadn't quite seen the issue about "dropdown buttons".
For 14: that's a select list and a link to click.
Some of the more complex pages like the Views ones probably need more general editing anyway.
Comment #22
jhodgdonThis looks great!
I had a couple of notes:
line goes over 80 characters, needs rewrapping. I fixed this before I committed the patch.
clikc -> click
I think this still needs some attention. Here's what I changed it to:
I think this is more accurate. If you think we need to change it more, please feel free to make a new patch for this section.
I took a look at the UI for this... I think this is more accurate, so I put this in (if you think it needs another edit, please make a new patch for this file):
Anyway... I made these small changes and applied the patch, and as far as I am concerned, this issue is fixed. THANKS very much!