Skip to content

Jcable/297 Change of standard for punctuation with quotation marks. #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julian-cable merged 3 commits into from
Jan 11, 2022
Merged

Jcable/297 Change of standard for punctuation with quotation marks. #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57d8938
#285 Minor punctuation fix
Dec 8, 2021
e335258
#297 Change of standard for punctuation with quotation marks.
Dec 8, 2021
61cb232
Further changes to Punctuation chapter
Dec 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en-US/Grammar.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@
<formalpara id="that">
<title>"That" in Clauses</title>
<para>
Include the word "that" in clauses unless it results in writing that is too formal or stilted. The use of the conjunction "that" makes the sentence easier to translate and improves clarity for readers whose primary language is not English,
Include the word "that" in clauses unless it results in writing that is too formal or stilted. The use of the conjunction "that" makes the sentence easier to translate and improves clarity for readers whose primary language is not English.
Copy link
Collaborator

@daobrien daobrien Dec 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't you fix this in #314 ?

Copy link
Collaborator Author

@julian-cable julian-cable Dec 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this commit wasn't intentionally included in this issue.

</para>

</formalpara>
Expand Down
37 changes: 31 additions & 6 deletions en-US/Punctuation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,19 +426,44 @@
<section id="quotation-marks">
<title>Quotation Marks</title>

<!-- Previous guidance
<para>
Commas and periods go inside quotation marks.
</para>
<para>
Question marks, exclamation points, dashes, and semicolons go inside the quotation marks if they are part of the quotation; if not, they go outside.
</para>
</section>
Question marks, exclamation points, dashes, and semicolons go inside the quotation marks if they are part of the quotation; if not, they go outside.
</para> -->

<!-- Not implementing this change for now.
<para>
In technical documentation, punctuation marks, including periods, commas, question marks, exclamation points, dashes, and semicolons go inside the quotation marks if they are part of the quotation; if not, they go outside.
In technical documentation, place punctuation marks, including periods, commas, question marks, exclamation points, dashes, and semicolons inside the quotation marks if they are part of the quotation or part of a programming element that uses quotation marks; if not, place punctuation marks outside the quotation marks.
If a sentence ends with a quotation, use only one punctuation mark to end the sentence, and place it inside the closing quotation mark if it is part of the quotation, or outside if it is not.

</para>
Add examples of when to use or not to use quotation marks.
<example><title>Correct Examples of the Use of Punctuation with Quotation Marks</title>
<para>
For bind mounts, add "bind" and set <command>fstype</command> to "none".
</para>
<screen>
Login successful.
...output omitted...
Using project "default".
</screen>
<para>
As you can see in the previous image, the title of the web page is "OpenShift 3 Etherpad".
</para>
<para>
In the program segment, ensure that the value is X'FF'.
</para>
<!-- <para>
If you use the keyword operand PGMID="PAYCOM", you must ...
Copy link
Collaborator

@daobrien daobrien Dec 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where did this example come from? I'm not sure how good of an example it is for what we're trying to demonstrate.

Copy link
Collaborator Author

@julian-cable julian-cable Dec 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It came from IBM Style. The idea was to show that the comma goes outside the quotation marks. I'll remove it and we have several other examples anyway.

</para> -->
<para>
Julius Caesar said, “I came. I saw. I conquered.”
</para>
</example>

</section>
<!-- Add examples of when to use or not to use quotation marks.
<example><title>Correct Examples of the Use of Quotation Marks</title>
<para>
For example, the following message indicates multiple possible solutions: "This message could be resolved by changing the time."
Expand Down