https://kumu.tru.ca/api.php?action=feedcontributions&user=MonaHall&feedformat=atomKumu Wiki - TRU - User contributions [en]2024-03-29T10:11:11ZUser contributionsMediaWiki 1.35.8https://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1023File Naming Conventions2014-01-23T19:26:50Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
::::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
<br />
::'''TYPE''' is the type of document, as follows:<br />
<br />
:{|<br />
|-<br />
| AK = Answer Key || KN = Lab Kit Notes <br />
|-<br />
| AS = Assignments|| MP = Major Project <br />
|-<br />
| CM = Course Manual|| PE = Practice Exam <br />
|-<br />
| CU = Course Units|| RD = Readings <br />
|-<br />
| FE = Final Exam|| SG = Study Guide <br />
|-<br />
| FEG = Final Exam Guide|| OLFMG = OLFM Guide <br />
|}<br />
<br />
::In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
::'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
::'''IN''' is the initials of the person who generated that file.<br />
<br />
::'''Here is a full example:''' <br />
<br />
::ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
<br />
:2. Final files (after sign off by Project Administrator)<br />
<br />
::Once the work has been completed, the files will be renamed according to the following example:<br />
<br />
:::'''ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''DATE''' is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008).<br />
<br />
::'''Here is a full example:'''<br />
<br />
:::ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1022File Naming Conventions2014-01-23T19:25:53Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
::::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
<br />
::'''TYPE''' is the type of document, as follows:<br />
<br />
:{|<br />
|-<br />
| AK = Answer Key || KN = Lab Kit Notes <br />
|-<br />
| AS = Assignments|| MP = Major Project <br />
|-<br />
| CM = Course Manual|| PE = Practice Exam <br />
|-<br />
| CU = Course Units|| RD = Readings <br />
|-<br />
| FE = Final Exam|| SG = Study Guide <br />
|-<br />
| FEG = Final Exam Guide|| OLFMG = OLFM Guide <br />
|}<br />
<br />
::In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
::'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
::'''IN''' is the initials of the person who generated that file.<br />
<br />
::'''Here is a full example:''' <br />
<br />
::ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
<br />
2. Final files (after sign off by Project Administrator)<br />
<br />
::Once the work has been completed, the files will be renamed according to the following example:<br />
<br />
:::'''ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''DATE''' is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008).<br />
<br />
::'''Here is a full example:'''<br />
<br />
:::ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1021File Naming Conventions2014-01-23T19:24:41Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
::::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
<br />
::'''TYPE''' is the type of document, as follows:<br />
<br />
:{|<br />
|-<br />
| AK = Answer Key || KN = Lab Kit Notes <br />
|-<br />
| AS = Assignments|| MP = Major Project <br />
|-<br />
| CM = Course Manual|| PE = Practice Exam <br />
|-<br />
| CU = Course Units|| RD = Readings <br />
|-<br />
| FE = Final Exam|| SG = Study Guide <br />
|-<br />
| FEG = Final Exam Guide|| OLFMG = OLFM Guide <br />
|}<br />
<br />
::In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
::'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
::'''IN''' is the initials of the person who generated that file.<br />
<br />
::'''Here is a full example:''' <br />
<br />
::ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
<br />
# 2. Final files (after sign off by Project Administrator)<br />
<br />
::Once the work has been completed, the files will be renamed according to the following example:<br />
<br />
:::'''ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''DATE''' is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008).<br />
<br />
::'''Here is a full example:'''<br />
<br />
:::ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1020File Naming Conventions2014-01-23T19:23:18Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
::::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
<br />
::'''TYPE''' is the type of document, as follows:<br />
<br />
:{|<br />
|-<br />
| AK = Answer Key || KN = Lab Kit Notes <br />
|-<br />
| AS = Assignments|| MP = Major Project <br />
|-<br />
| CM = Course Manual|| PE = Practice Exam <br />
|-<br />
| CU = Course Units|| RD = Readings <br />
|-<br />
| FE = Final Exam|| SG = Study Guide <br />
|-<br />
| FEG = Final Exam Guide|| OLFMG = OLFM Guide <br />
|}<br />
<br />
::In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
::'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
::'''IN''' is the initials of the person who generated that file.<br />
<br />
<br />
::'''Here is a full example:''' <br />
<br />
::ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
<br />
# 2. Final files (after sign off by Project Administrator)<br />
<br />
::Once the work has been completed, the files will be renamed according to the following example:<br />
<br />
:::'''ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''DATE''' is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008).<br />
<br />
::'''Here is a full example:'''<br />
<br />
:::ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1019File Naming Conventions2014-01-23T19:16:34Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
::::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
<br />
::'''TYPE''' is the type of document, as follows:<br />
<br />
:{|<br />
|-<br />
| AK = Answer Key || KN = Lab Kit Notes <br />
|-<br />
| AS = Assignments|| MP = Major Project <br />
|-<br />
| CM = Course Manual|| PE = Practice Exam <br />
|-<br />
| CU = Course Units|| RD = Readings <br />
|-<br />
| FE = Final Exam|| SG = Study Guide <br />
|-<br />
| FEG = Final Exam Guide|| OLFMG = OLFM Guide <br />
|}<br />
<br />
:In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
:'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
:'''IN''' is the initials of the person who generated that file.<br />
<br />
:'''Here is a full example:''' <br />
<br />
* :ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
<br />
# 2. <br />
Final files (after sign off by Project Administrator)<br />
<br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1018File Naming Conventions2014-01-23T19:15:03Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
::::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
<br />
::'''TYPE''' is the type of document, as follows:<br />
{|<br />
|-<br />
| AK = Answer Key || KN = Lab Kit Notes <br />
|-<br />
| AS = Assignments|| MP = Major Project <br />
|-<br />
| CM = Course Manual|| PE = Practice Exam <br />
|-<br />
| CU = Course Units|| RD = Readings <br />
|-<br />
| FE = Final Exam|| SG = Study Guide <br />
|-<br />
| FEG = Final Exam Guide|| OLFMG = OLFM Guide <br />
|}<br />
<br />
:In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
:'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
:'''IN''' is the initials of the person who generated that file.<br />
<br />
:'''Here is a full example:''' <br />
<br />
* :ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
<br />
# 2. <br />
Final files (after sign off by Project Administrator)<br />
<br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1017File Naming Conventions2014-01-23T19:13:54Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
::::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
<br />
::'''TYPE''' is the type of document, as follows:<br />
::{|<br />
::|-<br />
::| AK = Answer Key || KN = Lab Kit Notes <br />
::|-<br />
::| AS = Assignments|| MP = Major Project <br />
::|-<br />
::| CM = Course Manual|| PE = Practice Exam <br />
::|-<br />
::| CU = Course Units|| RD = Readings <br />
::|-<br />
::| FE = Final Exam|| SG = Study Guide <br />
::|-<br />
::| FEG = Final Exam Guide|| OLFMG = OLFM Guide <br />
::|}<br />
<br />
:In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
:'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
:'''IN''' is the initials of the person who generated that file.<br />
<br />
:'''Here is a full example:''' <br />
<br />
* :ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
<br />
# 2. <br />
Final files (after sign off by Project Administrator)<br />
<br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1016File Naming Conventions2014-01-23T19:12:27Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
:::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
::'''TYPE''' is the type of document, as follows:<br />
{|<br />
|-<br />
| AK = Answer Key || KN = Lab Kit Notes <br />
|-<br />
| AS = Assignments|| MP = Major Project <br />
|-<br />
| CM = Course Manual|| PE = Practice Exam <br />
|-<br />
| CU = Course Units|| RD = Readings <br />
|-<br />
| FE = Final Exam|| SG = Study Guide <br />
|-<br />
| FEG = Final Exam Guide|| OLFMG = OLFM Guide <br />
|}<br />
<br />
:In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
:'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
:'''IN''' is the initials of the person who generated that file.<br />
<br />
:'''Here is a full example:''' <br />
<br />
* :ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
<br />
# 2. <br />
Final files (after sign off by Project Administrator)<br />
<br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1015File Naming Conventions2014-01-23T19:07:00Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
:::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
::Where:<br />
<br />
::'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
::'''TYPE''' is the type of document, as follows:<br />
<br />
::AK = Answer Key KN = Lab Kit Notes <br />
<br />
::AS = Assignments MP = Major Project <br />
<br />
::CM = Course Manual PE = Practice Exam <br />
<br />
::CU = Course Units RD = Readings <br />
<br />
::FE = Final Exam SG = Study Guide <br />
<br />
::FEG = Final Exam Guide OLFMG = OLFM Guide <br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
'''IN''' is the initials of the person who generated that file.<br />
<br />
:'''Here is a full example:''' <br />
<br />
ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
# 2. <br />
Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1014File Naming Conventions2014-01-23T19:04:21Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
::All draft course files (Word and PDF) are named according to the following example:<br />
<br />
::'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
:Where:<br />
<br />
:'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871)<br />
<br />
:'''TYPE''' is the type of document, as follows:<br />
<br />
:AK = Answer Key LKN = Lab Kit Notes <br />
<br />
:AS = Assignments MP = Major Project <br />
<br />
:CM = Course Manual PE = Practice Exam <br />
<br />
:CU = Course Units RD = Readings <br />
<br />
:FE = Final Exam SG = Study Guide <br />
<br />
:FEG = Final Exam Guide OLFMG = OLFM Guide <br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
'''IN''' is the initials of the person who generated that file.<br />
<br />
:'''Here is a full example:''' <br />
<br />
ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
# 2. <br />
Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1013File Naming Conventions2014-01-23T19:01:38Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:All draft course files (Word and PDF) are named according to the following example: <br />
<br />
:<br />
:'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
Where: <br />
<br />
'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871) <br />
<br />
'''TYPE''' is the type of document, as follows: <br />
AK = Answer Key LKN = Lab Kit Notes <br />
AS = Assignments MP = Major Project <br />
CM = Course Manual PE = Practice Exam <br />
CU = Course Units RD = Readings <br />
FE = Final Exam SG = Study Guide <br />
FEG = Final Exam Guide OLFMG = OLFM Guide <br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
'''IN''' is the initials of the person who generated that file.<br />
<br />
:'''Here is a full example:''' <br />
<br />
ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
# 2. <br />
Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1012File Naming Conventions2014-01-23T18:58:57Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
All draft course files (Word and PDF) are named according to the following example: <br />
<br />
'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
Where: <br />
<br />
'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871) <br />
<br />
'''TYPE''' is the type of document, as follows: <br />
AK = Answer Key LKN = Lab Kit Notes <br />
AS = Assignments MP = Major Project <br />
CM = Course Manual PE = Practice Exam <br />
CU = Course Units RD = Readings <br />
FE = Final Exam SG = Study Guide <br />
FEG = Final Exam Guide OLFMG = OLFM Guide <br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
'''IN''' is the initials of the person who generated that file.<br />
<br />
:'''Here is a full example:''' <br />
<br />
ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
# 2. <br />
Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1011File Naming Conventions2014-01-23T18:57:37Z<p>MonaHall: /* File Naming Conventions */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
:Indented line<br />
All draft course files (Word and PDF) are named according to the following example: <br />
<br />
:Indented line<br />
:Indented line<br />
'''ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case)''' <br />
<br />
:Indented line<br />
Where: <br />
<br />
:Indented line<br />
'''ABCD1231''' is the course code (acronym and number; for example: ADMN4871) <br />
<br />
:Indented line<br />
'''TYPE''' is the type of document, as follows: <br />
AK = Answer Key LKN = Lab Kit Notes <br />
AS = Assignments MP = Major Project <br />
CM = Course Manual PE = Practice Exam <br />
CU = Course Units RD = Readings <br />
FE = Final Exam SG = Study Guide <br />
FEG = Final Exam Guide OLFMG = OLFM Guide <br />
<br />
:Indented line<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
:Indented line<br />
'''DATE''' is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
:Indented line<br />
'''IN''' is the initials of the person who generated that file.<br />
<br />
:'''Here is a full example:''' <br />
:<br />
* Indented line<br />
ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby.<br />
<br />
# 2. <br />
Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1010File Naming Conventions2014-01-23T18:52:12Z<p>MonaHall: /* File Naming Conventions Another Version 2014 */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
== File Naming Conventions ==<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
# Draft files are those that are in development or production in Curriculum Services. <br />
<br />
All draft course files (Word and PDF) are named according to the following example: <br />
<br />
ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case) <br />
<br />
Where: <br />
<br />
ABCD1231 is the course code (acronym and number; for example: ADMN4871) <br />
<br />
TYPE is the type of document, as follows: <br />
AK = Answer Key LKN = Lab Kit Notes <br />
AS = Assignments MP = Major Project <br />
CM = Course Manual PE = Practice Exam <br />
CU = Course Units RD = Readings <br />
FE = Final Exam SG = Study Guide <br />
FEG = Final Exam Guide OLFMG = OLFM Guide <br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A.<br />
<br />
DATE is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007.<br />
<br />
IN is the initials of the person who generated that file.<br />
<br />
Here is a full example:<br />
<br />
• ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 2. <br />
Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1009File Naming Conventions2014-01-23T18:44:03Z<p>MonaHall: /* File Naming Conventions Another Version 2014 */</p>
<hr />
<div>== File Naming Conventions Another Version 2014 ==<br />
File Naming Conventions<br />
File naming conventions are used in Curriculum Services for draft and final files, as explained here. <br />
1. Draft files are those that are in development or production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_IN_DRAFT.pdf or .doc (all upper case) <br />
Where: <br />
ABCD1231 is the course code (acronym and number; for example: ADMN4871) <br />
TYPE is the type of document, as follows: <br />
AK = Answer Key LKN = Lab Kit Notes <br />
AS = Assignments MP = Major Project <br />
CM = Course Manual PE = Practice Exam <br />
CU = Course Units RD = Readings <br />
FE = Final Exam SG = Study Guide <br />
FEG = Final Exam Guide OLFMG = OLFM Guide <br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign‐off for the final document—for example, DDMMMYYYY or 12OCT2007 for October 12, 2007. <br />
IN is the initials of the person who generated that file. <br />
Here is a full example: <br />
• ADMN4871_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN4871, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
2. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_ITEM#_DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
DATE is changed to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008). <br />
Here is a full example: <br />
• ADMN4871_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008.<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File_Naming_Conventions&diff=1008File Naming Conventions2014-01-23T18:43:17Z<p>MonaHall: </p>
<hr />
<div>== File Naming Conventions Another Version 2014 == <br />
<br />
<br />
<br />
== File Naming Conventions -- OLD ==<br />
We use file naming conventions in Curriculum Services for syntactical consistency, which in turn supports file management and helps Production to identify how files should be organized. <br />
<br />
We use naming conventions for the draft and final files of main course components. For other course resources files—readings, Excel workbooks, PowerPoints, images—we include key elements: Course Acronym, Location, and a short relevant descriptor. draft and final files, as explained here. <br />
<br />
=== Draft Files ===<br />
Draft files are those that are in development or production Production in Curriculum Services. <br />
All draft course files (Word and PDF) are named according to the following examplethus: <br />
<br />
ABCD1231_TYPE__ITEM#_DATEDDMMMYYYY_IN_DRAFT.pdf o r .doc (all upper case) <br />
<br />
Where: <br />
<br />
# ABCD1231 is the course code—the (acronym and number; for example: ADMN487, ENGL1061) <br />
# TYPE is the type of document and could include a subdivision, such as the file’s number or letter, as follows: <br />
:CG = Course Guide<br />
:CU = Course Units <br />
:CM = Course Modules<br />
:MOD = Module (and number or letter; e.g., MOD1)<br />
:AS = Assignments <br />
:MP = Major Project<br />
:PE = Practice Exam<br />
:EX_A = Final Exam, Form*<br />
:AK_A = Final Exam Answer Key, Form<br />
:OLFMG = Open Learning Faculty Member Guide<br />
:AK = Answer Key<br />
:RD = Reading(s)<br />
:SS = Style Sheet<br />
:AS = Assignments<br />
:CM = Course Manual<br />
:CU = Course<br />
:FE = Final Exam<br />
:FEG = Final Exam Guide<br />
<br />
In the case of multiple files of the same type, a unique identifier can be added to the type—for example, AS_C for Assignments C or CU_A for Unit A. <br />
# DATE DDMMYYYY is the date the last date that the file was last changed modifiedfor a draft or the date of sign‐off for the final document. <br />
<br />
For example: , DDMMMYYYY or 121SEPOCT2007013 for October 12, 2007. <br />
<br />
# IN is the initials of the person who generated that filewho last modified the file.<br />
# DRAFT means that the Course Lead has not yet reviewed and signed off on the file. This is sometimes not included if the file name is lengthy (as for readings or PowerPoint files ).<br />
# Do not add a filename extension (this happens automatically) <br />
<br />
Here is a full example of a named draft file:<br />
:Indented line<br />
ENGL1061_CU1_1SEP2013_DLM_DRAFT.doc [all uppercase except extension]<br />
<br />
=== Resource Files ===<br />
Other course resources files might include readings, Excel workbooks, PowerPoints, images, and so on. For these files, we use key elements: Course Acronym, Location, and a short but relevant descriptor. <br />
Example: APEC1671_MOD1_Title_of_reading<br />
The descriptor must match the actual, verbatim title of the resource, though it can be a truncated version of said title.<br />
=== Final Files ===<br />
After course development and sign-off by the Course Lead, who sends the files to Production, Production renames the files:ADMN487_SG_205611_02NOV2007_NK_DRAFT.pdf is the draft Study Guide with the item number 205611 for course ADMN487, which was last changed on November 2nd 2007 and generated by Nick Kirby. <br />
# 1. Final files (after sign off by Project Administrator) <br />
Once the work has been completed, the files will be renamed according to the following example: <br />
ABCD1231_TYPE_MMMYYYY_ITEM#_XXXXXX DATE_FINAL.pdf or .doc (all upper case) <br />
Where: <br />
# Numbered list item<br />
1. DATE is changed to to reflect only the month and year of the final document (e.g., MMMYYYY or OCT2008 for October 2008month and year only). <br />
2. XXXXXX: the Item Number is put in.<br />
3. IN is dropped.<br />
4. DRAFT is changed to FINAL.<br />
<br />
<br />
Here is a full example: <br />
* • ADMN487_SG_205611_NOV2008_FINAL.pdf is the final Study Guide with the item number 205611 for course ADMN487, which was last changed in November 2008. <br />
The final files are emailed by the Production Supervisor to the Divisional Secretary for upload to the GroupWise Library (with all previous tracked changes accepted, comments deleted, and track changes disabled).- <br />
Final versions of the file are held by Production within an organized storage format.<br />
<br />
== File Naming Conventions 2007 ==<br />
<br />
Naming conventions for course files <br />
All course files (Word and PDF) touched by the Production team should be named <br />
according to the following example: <br />
ABCD123_TYPE_DATE_IN_STATUS.pdf or .doc <br />
where <br />
ABCD123 is the course code (e.g. ADMN487) <br />
TYPE is the type of document: <br />
SG = Study Guide <br />
CM = Course Manual <br />
RD = Readings <br />
AS = Assignments <br />
PE = Practice Exam <br />
FE = Final Exam <br />
FEG = Final Exam Guide <br />
LKN = Lab Kit Notes <br />
CU = Course Units or Modules <br />
AK = Answer Key <br />
In case of multiple files of the same type a unique identifier can be added to <br />
the type, e.g. AS_C for Assignment File C or CU_A for Unit A. <br />
DATE is the last date that the file was changed for a draft or the date of sign-off <br />
for the final document (e.g. DDMMMYYYY or 12OCT2007 for October 12, <br />
2007). <br />
IN are the initials of the person who generated that file. <br />
STATUS is the current status of the file: <br />
DRAFT = File is a draft only and has not been signed off by the <br />
Instructional Designer. <br />
October 23, 2007<br />
FINAL = File has been signed off by the Instructional Designer and should <br />
not be changed in any way without the approval of the Instructional <br />
Designer, Operations Manager or Production Supervisor. <br />
Examples: <br />
ADMN487_SG_02NOV2007_NK_DRAFT.pdf is the draft Study Guide for <br />
course ADMN487 which was last changed on November 2nd<br />
2007 and <br />
generated by Nick Kirby. <br />
FRST305_CM_12OCT2007_MV_FINAL.pdf is the signed-off and final Course <br />
Manual for FRST305 which was signed off on October 12th<br />
2007 and <br />
generated by Martin Voelkening.</div>MonaHallhttps://kumu.tru.ca/index.php?title=File:File_Naming_Conventions_Draft.docx&diff=1007File:File Naming Conventions Draft.docx2014-01-23T18:18:24Z<p>MonaHall: MonaHall uploaded a new version of &quot;File:File Naming Conventions Draft.docx&quot;: Changed Course Numbers to reflect change from 3-digit to 4-digit numbers</p>
<hr />
<div>=={{int:filedesc}}==<br />
{{Information<br />
|description={{en|1=File naming conventions}}<br />
|date=2014-01-23 10:03:22<br />
|source={{own}}<br />
|author=[[User:MonaHall|MonaHall]]<br />
|permission=<br />
|other_versions=<br />
|other_fields=<br />
}}<br />
<br />
=={{int:license-header}}==<br />
{{self|cc-by-sa-3.0}}</div>MonaHallhttps://kumu.tru.ca/index.php?title=File:File_Naming_Conventions_Draft.docx&diff=1006File:File Naming Conventions Draft.docx2014-01-23T18:05:31Z<p>MonaHall: User created page with UploadWizard</p>
<hr />
<div>=={{int:filedesc}}==<br />
{{Information<br />
|description={{en|1=File naming conventions}}<br />
|date=2014-01-23 10:03:22<br />
|source={{own}}<br />
|author=[[User:MonaHall|MonaHall]]<br />
|permission=<br />
|other_versions=<br />
|other_fields=<br />
}}<br />
<br />
=={{int:license-header}}==<br />
{{self|cc-by-sa-3.0}}</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=952Writing Conventions2014-01-14T20:26:57Z<p>MonaHall: /* Capitalization */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* When space is limited, for example, in a figure description <br />
* When an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* Only in contexts where they are clear to the reader <br />
* Only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* Only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name.<br />
<br />
:'''Example:''' use severe acute respiratory syndrome (SARS) and International Business Machines (IBM).<br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary'' (''COD''); ''Journal of the American Medical Association'' (''JAMA''); ibid., etc., e.g., i.e.<br />
<br />
:'''Note:''' Parentheses are not in italics.<br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
:'''Incorrect''': The student logs on using his or her password.<br />
:<br />
:'''Correct''': The student logs on using their password. <br />
<br />
:<br />
:'''Incorrect''': Complete your initial draft after you enter her comments.<br />
:<br />
:'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
:<br />
:'''Incorrect''': man-hours<br />
:<br />
:'''Correct''': work hours<br />
<br />
:<br />
:'''Incorrect''': workman<br />
:<br />
:'''Correct''': worker<br />
<br />
:<br />
:'''Incorrect''': manpower<br />
:<br />
:'''Correct''': staff, human resources<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
:'''Examples of words:''' cool, y’all, wanna<br />
:<br />
:'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
:<br />
:'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
::1) tags: for example “he hissed,” “she whispered”; <br />
::2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
* Appropriate language<br />
* Articles<br />
* Bold text<br />
* Capitalization <br />
* '''Captions''' <br />
* Colon<br />
* '''Colloquialisms, idioms, non-standard English, slang'''<br />
* Comma<br />
* Concision<br />
* Contractions<br />
* Copyright notices<br />
* '''Dashes'''<br />
* Dates<br />
* Determiners<br />
* Direct address<br />
* Ellipsis<br />
* Figures and figure captions<br />
* Footnotes<br />
* '''Foreign terms'''<br />
* Gerunds<br />
* Headings<br />
* Hyperlinks<br />
* Hyphen<br />
* Italics<br />
* Lists<br />
* '''Latin terms''' (use sparingly)<br />
* Measurement conventions<br />
* Miscellaneous<br />
* Numbering<br />
* Parallelism<br />
* Parenthesis, brackets, and braces<br />
* '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
* '''Per cent or %'''<br />
* Pet peeves <br />
* Plain English<br />
* Plurals<br />
* Positive statements<br />
* Precision <br />
* Procedures [click (v.), not click on]<br />
* Pronouns<br />
* Quotation marks<br />
* References<br />
* '''Repetition (Wordiness, concise instructions ??)''' <br />
* Semicolon<br />
* Slash<br />
* Spelling<br />
* Subject-verb agreement<br />
* '''Subordinate sentence structure''' <br />
* Tables<br />
* That and which <br />
* URLs<br />
* User interface terminology and style<br />
* Verb tense<br />
* Word choice <br />
* '''Would and will (added since Aug meeting)'''<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=949Writing Conventions2014-01-14T20:26:07Z<p>MonaHall: /* When to use abbreviations */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* When space is limited, for example, in a figure description <br />
* When an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* Only in contexts where they are clear to the reader <br />
* Only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* Only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary'' (''COD''); ''Journal of the American Medical Association'' (''JAMA''); ibid., etc., e.g., i.e.<br />
<br />
:'''Note:''' Parentheses are not in italics.<br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
:'''Incorrect''': The student logs on using his or her password.<br />
:<br />
:'''Correct''': The student logs on using their password. <br />
<br />
:<br />
:'''Incorrect''': Complete your initial draft after you enter her comments.<br />
:<br />
:'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
:<br />
:'''Incorrect''': man-hours<br />
:<br />
:'''Correct''': work hours<br />
<br />
:<br />
:'''Incorrect''': workman<br />
:<br />
:'''Correct''': worker<br />
<br />
:<br />
:'''Incorrect''': manpower<br />
:<br />
:'''Correct''': staff, human resources<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
:'''Examples of words:''' cool, y’all, wanna<br />
:<br />
:'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
:<br />
:'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
::1) tags: for example “he hissed,” “she whispered”; <br />
::2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
* Appropriate language<br />
* Articles<br />
* Bold text<br />
* Capitalization <br />
* '''Captions''' <br />
* Colon<br />
* '''Colloquialisms, idioms, non-standard English, slang'''<br />
* Comma<br />
* Concision<br />
* Contractions<br />
* Copyright notices<br />
* '''Dashes'''<br />
* Dates<br />
* Determiners<br />
* Direct address<br />
* Ellipsis<br />
* Figures and figure captions<br />
* Footnotes<br />
* '''Foreign terms'''<br />
* Gerunds<br />
* Headings<br />
* Hyperlinks<br />
* Hyphen<br />
* Italics<br />
* Lists<br />
* '''Latin terms''' (use sparingly)<br />
* Measurement conventions<br />
* Miscellaneous<br />
* Numbering<br />
* Parallelism<br />
* Parenthesis, brackets, and braces<br />
* '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
* '''Per cent or %'''<br />
* Pet peeves <br />
* Plain English<br />
* Plurals<br />
* Positive statements<br />
* Precision <br />
* Procedures [click (v.), not click on]<br />
* Pronouns<br />
* Quotation marks<br />
* References<br />
* '''Repetition (Wordiness, concise instructions ??)''' <br />
* Semicolon<br />
* Slash<br />
* Spelling<br />
* Subject-verb agreement<br />
* '''Subordinate sentence structure''' <br />
* Tables<br />
* That and which <br />
* URLs<br />
* User interface terminology and style<br />
* Verb tense<br />
* Word choice <br />
* '''Would and will (added since Aug meeting)'''<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=945Writing Conventions2014-01-14T20:24:47Z<p>MonaHall: /* Italicize abbreviations */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary'' (''COD''); ''Journal of the American Medical Association'' (''JAMA''); ibid., etc., e.g., i.e.<br />
<br />
:'''Note:''' Parentheses are not in italics.<br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
:'''Incorrect''': The student logs on using his or her password.<br />
:<br />
:'''Correct''': The student logs on using their password. <br />
<br />
:<br />
:'''Incorrect''': Complete your initial draft after you enter her comments.<br />
:<br />
:'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
:<br />
:'''Incorrect''': man-hours<br />
:<br />
:'''Correct''': work hours<br />
<br />
:<br />
:'''Incorrect''': workman<br />
:<br />
:'''Correct''': worker<br />
<br />
:<br />
:'''Incorrect''': manpower<br />
:<br />
:'''Correct''': staff, human resources<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
:'''Examples of words:''' cool, y’all, wanna<br />
:<br />
:'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
:<br />
:'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
::1) tags: for example “he hissed,” “she whispered”; <br />
::2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
* Appropriate language<br />
* Articles<br />
* Bold text<br />
* Capitalization <br />
* '''Captions''' <br />
* Colon<br />
* '''Colloquialisms, idioms, non-standard English, slang'''<br />
* Comma<br />
* Concision<br />
* Contractions<br />
* Copyright notices<br />
* '''Dashes'''<br />
* Dates<br />
* Determiners<br />
* Direct address<br />
* Ellipsis<br />
* Figures and figure captions<br />
* Footnotes<br />
* '''Foreign terms'''<br />
* Gerunds<br />
* Headings<br />
* Hyperlinks<br />
* Hyphen<br />
* Italics<br />
* Lists<br />
* '''Latin terms''' (use sparingly)<br />
* Measurement conventions<br />
* Miscellaneous<br />
* Numbering<br />
* Parallelism<br />
* Parenthesis, brackets, and braces<br />
* '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
* '''Per cent or %'''<br />
* Pet peeves <br />
* Plain English<br />
* Plurals<br />
* Positive statements<br />
* Precision <br />
* Procedures [click (v.), not click on]<br />
* Pronouns<br />
* Quotation marks<br />
* References<br />
* '''Repetition (Wordiness, concise instructions ??)''' <br />
* Semicolon<br />
* Slash<br />
* Spelling<br />
* Subject-verb agreement<br />
* '''Subordinate sentence structure''' <br />
* Tables<br />
* That and which <br />
* URLs<br />
* User interface terminology and style<br />
* Verb tense<br />
* Word choice <br />
* '''Would and will (added since Aug meeting)'''<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=944Writing Conventions2014-01-14T20:23:49Z<p>MonaHall: /* Italicize abbreviations */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
'''Example:''' ''Canadian Oxford Dictionary'' (''COD''); ''Journal of the American Medical Association'' (''JAMA''); ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics.<br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
:'''Incorrect''': The student logs on using his or her password.<br />
:<br />
:'''Correct''': The student logs on using their password. <br />
<br />
:<br />
:'''Incorrect''': Complete your initial draft after you enter her comments.<br />
:<br />
:'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
:<br />
:'''Incorrect''': man-hours<br />
:<br />
:'''Correct''': work hours<br />
<br />
:<br />
:'''Incorrect''': workman<br />
:<br />
:'''Correct''': worker<br />
<br />
:<br />
:'''Incorrect''': manpower<br />
:<br />
:'''Correct''': staff, human resources<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
:'''Examples of words:''' cool, y’all, wanna<br />
:<br />
:'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
:<br />
:'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
::1) tags: for example “he hissed,” “she whispered”; <br />
::2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
* Appropriate language<br />
* Articles<br />
* Bold text<br />
* Capitalization <br />
* '''Captions''' <br />
* Colon<br />
* '''Colloquialisms, idioms, non-standard English, slang'''<br />
* Comma<br />
* Concision<br />
* Contractions<br />
* Copyright notices<br />
* '''Dashes'''<br />
* Dates<br />
* Determiners<br />
* Direct address<br />
* Ellipsis<br />
* Figures and figure captions<br />
* Footnotes<br />
* '''Foreign terms'''<br />
* Gerunds<br />
* Headings<br />
* Hyperlinks<br />
* Hyphen<br />
* Italics<br />
* Lists<br />
* '''Latin terms''' (use sparingly)<br />
* Measurement conventions<br />
* Miscellaneous<br />
* Numbering<br />
* Parallelism<br />
* Parenthesis, brackets, and braces<br />
* '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
* '''Per cent or %'''<br />
* Pet peeves <br />
* Plain English<br />
* Plurals<br />
* Positive statements<br />
* Precision <br />
* Procedures [click (v.), not click on]<br />
* Pronouns<br />
* Quotation marks<br />
* References<br />
* '''Repetition (Wordiness, concise instructions ??)''' <br />
* Semicolon<br />
* Slash<br />
* Spelling<br />
* Subject-verb agreement<br />
* '''Subordinate sentence structure''' <br />
* Tables<br />
* That and which <br />
* URLs<br />
* User interface terminology and style<br />
* Verb tense<br />
* Word choice <br />
* '''Would and will (added since Aug meeting)'''<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=940Writing Conventions2014-01-14T20:16:25Z<p>MonaHall: /* Gender bias */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
:'''Incorrect''': The student logs on using his or her password.<br />
:<br />
:'''Correct''': The student logs on using their password. <br />
<br />
:<br />
:'''Incorrect''': Complete your initial draft after you enter her comments.<br />
:<br />
:'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
:<br />
:'''Incorrect''': man-hours<br />
:<br />
:'''Correct''': work hours<br />
<br />
:<br />
:'''Incorrect''': workman<br />
:<br />
:'''Correct''': worker<br />
<br />
:<br />
:'''Incorrect''': manpower<br />
:<br />
:'''Correct''': staff, human resources<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
:'''Examples of words:''' cool, y’all, wanna<br />
:<br />
:'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
:<br />
:'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
::1) tags: for example “he hissed,” “she whispered”; <br />
::2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
* Appropriate language<br />
* Articles<br />
* Bold text<br />
* Capitalization <br />
* '''Captions''' <br />
* Colon<br />
* '''Colloquialisms, idioms, non-standard English, slang'''<br />
* Comma<br />
* Concision<br />
* Contractions<br />
* Copyright notices<br />
* '''Dashes'''<br />
* Dates<br />
* Determiners<br />
* Direct address<br />
* Ellipsis<br />
* Figures and figure captions<br />
* Footnotes<br />
* '''Foreign terms'''<br />
* Gerunds<br />
* Headings<br />
* Hyperlinks<br />
* Hyphen<br />
* Italics<br />
* Lists<br />
* '''Latin terms''' (use sparingly)<br />
* Measurement conventions<br />
* Miscellaneous<br />
* Numbering<br />
* Parallelism<br />
* Parenthesis, brackets, and braces<br />
* '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
* '''Per cent or %'''<br />
* Pet peeves <br />
* Plain English<br />
* Plurals<br />
* Positive statements<br />
* Precision <br />
* Procedures [click (v.), not click on]<br />
* Pronouns<br />
* Quotation marks<br />
* References<br />
* '''Repetition (Wordiness, concise instructions ??)''' <br />
* Semicolon<br />
* Slash<br />
* Spelling<br />
* Subject-verb agreement<br />
* '''Subordinate sentence structure''' <br />
* Tables<br />
* That and which <br />
* URLs<br />
* User interface terminology and style<br />
* Verb tense<br />
* Word choice <br />
* '''Would and will (added since Aug meeting)'''<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=936Writing Conventions2014-01-14T20:15:37Z<p>MonaHall: /* Jargon and colloquialisms */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
:'''Incorrect''': The student logs on using his or her password.<br />
:<br />
:'''Correct''': The student logs on using their password. <br />
:<br />
:'''Incorrect''': Complete your initial draft after you enter her comments.<br />
:<br />
:'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
:<br />
:'''Incorrect''': man-hours<br />
:<br />
:'''Correct''': work hours<br />
:<br />
:'''Incorrect''': workman<br />
:<br />
:'''Correct''': worker<br />
:<br />
:'''Incorrect''': manpower<br />
:<br />
:'''Correct''': staff, human resources<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
:'''Examples of words:''' cool, y’all, wanna<br />
:<br />
:'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
:<br />
:'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
::1) tags: for example “he hissed,” “she whispered”; <br />
::2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
* Appropriate language<br />
* Articles<br />
* Bold text<br />
* Capitalization <br />
* '''Captions''' <br />
* Colon<br />
* '''Colloquialisms, idioms, non-standard English, slang'''<br />
* Comma<br />
* Concision<br />
* Contractions<br />
* Copyright notices<br />
* '''Dashes'''<br />
* Dates<br />
* Determiners<br />
* Direct address<br />
* Ellipsis<br />
* Figures and figure captions<br />
* Footnotes<br />
* '''Foreign terms'''<br />
* Gerunds<br />
* Headings<br />
* Hyperlinks<br />
* Hyphen<br />
* Italics<br />
* Lists<br />
* '''Latin terms''' (use sparingly)<br />
* Measurement conventions<br />
* Miscellaneous<br />
* Numbering<br />
* Parallelism<br />
* Parenthesis, brackets, and braces<br />
* '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
* '''Per cent or %'''<br />
* Pet peeves <br />
* Plain English<br />
* Plurals<br />
* Positive statements<br />
* Precision <br />
* Procedures [click (v.), not click on]<br />
* Pronouns<br />
* Quotation marks<br />
* References<br />
* '''Repetition (Wordiness, concise instructions ??)''' <br />
* Semicolon<br />
* Slash<br />
* Spelling<br />
* Subject-verb agreement<br />
* '''Subordinate sentence structure''' <br />
* Tables<br />
* That and which <br />
* URLs<br />
* User interface terminology and style<br />
* Verb tense<br />
* Word choice <br />
* '''Would and will (added since Aug meeting)'''<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=931Writing Conventions2014-01-14T20:11:58Z<p>MonaHall: /* Jargon and colloquialisms */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
:'''Incorrect''': The student logs on using his or her password.<br />
:<br />
:'''Correct''': The student logs on using their password. <br />
:<br />
:'''Incorrect''': Complete your initial draft after you enter her comments.<br />
:<br />
:'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
:<br />
:'''Incorrect''': man-hours<br />
:<br />
:'''Correct''': work hours<br />
:<br />
:'''Incorrect''': workman<br />
:<br />
:'''Correct''': worker<br />
:<br />
:'''Incorrect''': manpower<br />
:<br />
:'''Correct''': staff, human resources<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
:'''Examples of words:''' cool, y’all, wanna<br />
:<br />
:'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
:<br />
:'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
::1) tags: for example “he hissed,” “she whispered”; <br />
::2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=929Writing Conventions2014-01-14T20:11:31Z<p>MonaHall: /* Jargon and colloquialisms */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
:'''Incorrect''': The student logs on using his or her password.<br />
:<br />
:'''Correct''': The student logs on using their password. <br />
:<br />
:'''Incorrect''': Complete your initial draft after you enter her comments.<br />
:<br />
:'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
:<br />
:'''Incorrect''': man-hours<br />
:<br />
:'''Correct''': work hours<br />
:<br />
:'''Incorrect''': workman<br />
:<br />
:'''Correct''': worker<br />
:<br />
:'''Incorrect''': manpower<br />
:<br />
:'''Correct''': staff, human resources<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
:'''Examples of words:''' cool, y’all, wanna<br />
:<br />
:'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
:<br />
:'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
:1) tags: for example “he hissed,” “she whispered”; <br />
:2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=928Writing Conventions2014-01-14T20:10:56Z<p>MonaHall: /* Gender bias */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
:'''Incorrect''': The student logs on using his or her password.<br />
:<br />
:'''Correct''': The student logs on using their password. <br />
:<br />
:'''Incorrect''': Complete your initial draft after you enter her comments.<br />
:<br />
:'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
:<br />
:'''Incorrect''': man-hours<br />
:<br />
:'''Correct''': work hours<br />
:<br />
:'''Incorrect''': workman<br />
:<br />
:'''Correct''': worker<br />
:<br />
:'''Incorrect''': manpower<br />
:<br />
:'''Correct''': staff, human resources<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=926Writing Conventions2014-01-14T20:09:58Z<p>MonaHall: /* Some exceptions */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
:'''Examples:''' <br />
:the species’ first emergence<br />
:politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
:'''Examples:'''<br />
:the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=924Writing Conventions2014-01-14T20:09:28Z<p>MonaHall: /* Apostrophe */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
:'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s<br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
:'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=921Writing Conventions2014-01-14T20:07:41Z<p>MonaHall: /* Anthropomorphism */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
:'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
:'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=920Writing Conventions2014-01-14T20:07:12Z<p>MonaHall: /* Passive Voice */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
New material added from this point forward.<br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=919Writing Conventions2014-01-14T20:06:56Z<p>MonaHall: /* Active Voice */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
:'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
:'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=916Writing Conventions2014-01-14T20:00:09Z<p>MonaHall: /* Apostrophe */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words.<br />
<br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers.<br />
<br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only.<br />
<br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction)<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=915Writing Conventions2014-01-14T19:59:36Z<p>MonaHall: /* Anthropomorphism */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms.<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=914Writing Conventions2014-01-14T19:59:12Z<p>MonaHall: /* Active Voice */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
<br />
'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
<br />
'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms. <br />
<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=913Writing Conventions2014-01-14T19:58:05Z<p>MonaHall: /* Abbreviations */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
:'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
:'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
:'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
:'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
:'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
:'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
:'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
<br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
:'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
'''Note:''' Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
:'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
:'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
:'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
:'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms. <br />
<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=909Writing Conventions2014-01-14T19:52:54Z<p>MonaHall: /* Abbreviations */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
Note: Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms. <br />
<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=908Writing Conventions2014-01-14T19:52:14Z<p>MonaHall: /* Abbreviations */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase.<br />
<br />
:Indented line<br />
'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
<br />
:Indented line<br />
'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
<br />
:Indented line<br />
'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name.<br />
<br />
'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
<br />
'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
<br />
'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
<br />
'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
<br />
'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
<br />
'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
<br />
'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e.<br />
<br />
Note: Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud.<br />
<br />
'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
<br />
'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
<br />
'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form.<br />
<br />
'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms. <br />
<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=906Writing Conventions2014-01-14T19:49:50Z<p>MonaHall: /* When to use abbreviations */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase. <br />
'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* when space is limited, for example, in a figure description <br />
* when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* only in contexts where they are clear to the reader <br />
* only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name. <br />
'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e. <br />
Note: Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud. <br />
'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form. <br />
'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms. <br />
<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=905Writing Conventions2014-01-14T19:49:09Z<p>MonaHall: /* When to use abbreviations */</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase. <br />
'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
<br />
* ● when space is limited, for example, in a figure description <br />
* ● when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV. <br />
* ● only in contexts where they are clear to the reader <br />
* ● only when necessary, since an overuse of abbreviations can inhibit understanding and clarity <br />
* ● only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
* ● Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
* ● Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name. <br />
'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e. <br />
Note: Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud. <br />
'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form. <br />
'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms. <br />
<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=904Writing Conventions2014-01-14T19:47:55Z<p>MonaHall: </p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
== Editorial Style Guide Project: Writing Conventions Text ==<br />
=== Abbreviations ===<br />
<br />
An ''abbreviation'' is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase. <br />
'''Example:''' the abbreviation for ''abbreviation'' is abbr., abbrv., or abbrev.<br />
<br />
An ''acronym'', a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
'''Example:''' NATO or UNICEF<br />
<br />
An ''initialism'', another form of abbreviation, refers to terms read as a series of letters.<br />
'''Example:''' BBC, ATM, DNA<br />
<br />
==== When to use abbreviations ====<br />
Use an abbreviation in the following situations:<br />
● when space is limited, for example, in a figure description<br />
● when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV.<br />
● only in contexts where they are clear to the reader <br />
● only when necessary, since an overuse of abbreviations can inhibit understanding and clarity<br />
● only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
● Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
● Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
==== Capitalization ====<br />
<br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name. <br />
'''Example:''' use 6 ft and 200 Hz.<br />
<br />
==== Pluralization ====<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
'''Example:''' use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
==== Punctuation ====<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
'''Example:''' use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
'''Example:''' use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
'''Example:''' Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
'''Example:''' cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
'''Example:''' lb., in., qt., yd.<br />
<br />
==== Latin terms [move to somewhere else] ====<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. ''Et cetera'' and etc. <br />
==== Italicize abbreviations ==== <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
'''Example:''' ''Canadian Oxford Dictionary ''(''COD'')''''; ''Journal of the American Medical Association ''(''JAMA'')''''; ibid., etc., e.g., i.e. <br />
Note: Parentheses are not in italics. <br />
<br />
==== Articles (a, an, the) preceding an abbreviation ====<br />
When an abbreviation follows an indefinite article, choose ''a'' or ''an'' depending on the way the abbreviation sounds when read aloud. <br />
'''Example:''' an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by ''a'', ''an'', or ''the''.<br />
'''Example:''' member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
'''Example:''' member nations of the EU<br />
<br />
==== Page / table / textual / References to non-OL materials [Revisit this …] ====<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form. <br />
'''Example:''' ''page'' not ''p.'', ''figure'' not ''fig.''<br />
<br />
<br />
=== Active Voice ===<br />
Use the ''active voice'' whenever possible, unless genre conventions specifically require the passive voice. Eliminate the ''passive voice'' whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
'''Example of passive voice:''' The environmental damage was caused by the negligent oil company.<br />
'''Example of active voice:''' The negligent oil company caused the environmental damage.<br />
<br />
=== Passive Voice === <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
=== Anthropomorphism ===<br />
<br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
'''Example of anthropomorphism:''' The financial market’s impact on the 2008 recession was wide and deep.<br />
'''Correct version:''' The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, ''animism'' is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called ''anthropocentrism'', which is a conscious or unconscious belief in human exceptionalism. For example, in ''The Descent of Man'', Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms. <br />
<br />
<br />
=== Apostrophe ===<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
'''Examples:''' the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
'''Examples:''' Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
==== Some exceptions ====<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
'''Examples:''' <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
'''Examples:'''<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
=== Appropriate Language ===<br />
==== Gender bias ====<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either ''he'' or ''she'' to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
'''Incorrect''': The student logs on using his or her password.<br />
'''Correct''': The student logs on using their password. <br />
<br />
'''Incorrect''': Complete your initial draft after you enter her comments.<br />
'''Correct''': Complete your initial draft after you enter the editor’s comments.<br />
<br />
'''Incorrect''': man-hours<br />
'''Correct''': work hours<br />
<br />
'''Incorrect''': workman<br />
'''Correct''': worker<br />
<br />
'''Incorrect''': manpower<br />
'''Correct''': staff, human resources<br />
<br />
<br />
==== Jargon and colloquialisms ====<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
'''Examples of words:''' cool, y’all, wanna<br />
<br />
'''Examples of phrases:''' dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
<br />
'''Examples of paralanguage:''' Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: <br />
1) tags: for example “he hissed,” “she whispered”; <br />
2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those '''highlighted in yellow''' were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● '''Captions''' <br />
● Colon<br />
● '''Colloquialisms, idioms, non-standard English, slang'''<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● '''Dashes'''<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● '''Foreign terms'''<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● '''Latin terms''' (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● '''Passive voice''' (see anthropomorphism for situations when passive voice is acceptable) <br />
● '''Per cent or %'''<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● '''Repetition (Wordiness, concise instructions ??)''' <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● '''Subordinate sentence structure''' <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● '''Would and will (added since Aug meeting)'''<br />
<br />
<br />
'''Note:''' Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=865Writing Conventions2014-01-14T19:19:19Z<p>MonaHall: </p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
<br />
Editorial Style Guide Project: Writing Conventions Text<br />
Abbreviations <br />
An abbreviation is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase. <br />
Example: the abbreviation for abbreviation is abbr., abbrv., or abbrev.<br />
<br />
An acronym, a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
Example: NATO or UNICEF<br />
<br />
An initialism, another form of abbreviation, refers to terms read as a series of letters.<br />
Example: BBC, ATM, DNA<br />
<br />
When to use abbreviations<br />
Use an abbreviation in the following situations:<br />
● when space is limited, for example, in a figure description<br />
● when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV.<br />
● only in contexts where they are clear to the reader <br />
● only when necessary, since an overuse of abbreviations can inhibit understanding and clarity<br />
● only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
● Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
● Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
Capitalization <br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name. <br />
Example: use 6 ft and 200 Hz.<br />
<br />
Pluralization<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
Example: use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
Punctuation<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
Example: use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
Example: use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
Example: Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
Example: cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
Example: lb., in., qt., yd.<br />
<br />
Latin terms [move to somewhere else]<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. Et cetera and etc. <br />
Italicize abbreviations <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
Example: Canadian Oxford Dictionary (COD); Journal of the American Medical Association (JAMA); ibid., etc., e.g., i.e. Note: Parentheses are not in italics. <br />
<br />
Articles (a, an, the) preceding an abbreviation<br />
When an abbreviation follows an indefinite article, choose a or an depending on the way the abbreviation sounds when read aloud. <br />
Example: an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by a, an, or the.<br />
Example: member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
Example: member nations of the EU<br />
<br />
Page / table / textual / References to non-OL materials [Revisit this …]<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form. <br />
Example: page not p., figure not fig.<br />
<br />
<br />
Active Voice<br />
Use the active voice whenever possible, unless genre conventions specifically require the passive voice. Eliminate the passive voice whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
Example of passive voice: The environmental damage was caused by the negligent oil company.<br />
Example of active voice: The negligent oil company caused the environmental damage.<br />
<br />
Passive Voice <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
Anthropomorphism <br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
Example of anthropomorphism: The financial market’s impact on the 2008 recession was wide and deep.<br />
Correct version: The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, animism is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called anthropocentrism, which is a conscious or unconscious belief in human exceptionalism. For example, in The Descent of Man, Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms. <br />
<br />
<br />
Apostrophe<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
Examples: the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
Examples: Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
Some exceptions<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
Examples: <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
Examples:<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
Appropriate Language<br />
Gender bias<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either he or she to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
Incorrect: The student logs on using his or her password.<br />
Correct: The student logs on using their password. <br />
<br />
Incorrect: Complete your initial draft after you enter her comments.<br />
Correct: Complete your initial draft after you enter the editor’s comments.<br />
<br />
Incorrect: man-hours<br />
Correct: work hours<br />
<br />
Incorrect: workman<br />
Correct: worker<br />
<br />
Incorrect: manpower<br />
Correct: staff, human resources<br />
<br />
<br />
Jargon and colloquialisms<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
Examples of words: cool, y’all, wanna<br />
<br />
Examples of phrases: dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
Examples of paralanguage: Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: 1) tags: for example “he hissed,” “she whispered”; 2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those highlighted in yellow were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● Captions <br />
● Colon<br />
● Colloquialisms, idioms, non-standard English, slang<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● Dashes<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● Foreign terms<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● Latin terms (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● Passive voice (see anthropomorphism for situations when passive voice is acceptable) <br />
● Per cent or %<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● Repetition (Wordiness, concise instructions ??) <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● Subordinate sentence structure <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● Would and will (added since Aug meeting)<br />
<br />
<br />
Note: Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHallhttps://kumu.tru.ca/index.php?title=Writing_Conventions&diff=863Writing Conventions2014-01-14T19:18:35Z<p>MonaHall: Created page with "/Plain language - what do we mean... where / when appropriate / Editorial Style Guide Project: Writing Conventions Text Abbreviations An abbreviation is a shortened form of ..."</p>
<hr />
<div>/Plain language - what do we mean... where / when appropriate / <br />
Editorial Style Guide Project: Writing Conventions Text<br />
Abbreviations <br />
An abbreviation is a shortened form of a word or phrase. Usually, an abbreviation is a group of letters taken from the word or phrase. <br />
Example: the abbreviation for abbreviation is abbr., abbrv., or abbrev.<br />
<br />
An acronym, a type of abbreviation, is derived from the initial letters of a compound term, which is read as a single word.<br />
Example: NATO or UNICEF<br />
<br />
An initialism, another form of abbreviation, refers to terms read as a series of letters.<br />
Example: BBC, ATM, DNA<br />
<br />
When to use abbreviations<br />
Use an abbreviation in the following situations:<br />
● when space is limited, for example, in a figure description<br />
● when an abbreviation is more immediately recognizable, for example modem, NAFTA, HIV.<br />
● only in contexts where they are clear to the reader <br />
● only when necessary, since an overuse of abbreviations can inhibit understanding and clarity<br />
● only when the term that you want to abbreviate appears at least more than twice in a module <br />
<br />
Generally:<br />
● Expand all abbreviations and acronyms at their first use within a module (or in a paper or chapter), except for commonly known standard abbreviations such as laser or modem. After this expanded name, enclose the acronym or abbreviation within parenthesis marks. The next time you want to refer to the acronym or abbreviation in the same chapter, you can use the acronym by itself.<br />
● Spell out a unit of measure the first time you use it in a module (or in a paper or chapter), followed by its abbreviation in parentheses. After its first use, use the abbreviation in text as well as in figures and tables.<br />
<br />
Capitalization <br />
Use a lowercase font to expand an acronym, unless it is a proper noun or product name. Example: use severe acute respiratory syndrome (SARS) and International Business Machines (IBM). <br />
<br />
Write abbreviations of words and units of measurement in a lowercase font, except those derived from a proper name. <br />
Example: use 6 ft and 200 Hz.<br />
<br />
Pluralization<br />
Add a lowercase “s” to an abbreviation or acronym to make it plural. If an acronym is already plural, do not add an “s.” Do not put an apostrophe before the final “s” in a plural acronym or initialism.<br />
Example: use central processing units (CPUs) and bachelors of business administration (BBAs).<br />
<br />
Punctuation<br />
Do not use periods in an abbreviation unless the term is an official or registered abbreviation that contains them.<br />
Example: use a.m., p.m., B.A.<br />
<br />
If a reader might confuse an abbreviation with another word, use a period after an abbreviation.<br />
Example: use no. for number and in. for inch<br />
<br />
Use periods in abbreviations of titles.<br />
Example: Mr., Mrs., Dr.<br />
<br />
Never use periods with metric abbreviations.<br />
Example: cm, m, km, L<br />
<br />
The Canadian Oxford Dictionary uses periods with imperial abbreviations.<br />
Example: lb., in., qt., yd.<br />
<br />
Latin terms [move to somewhere else]<br />
Italicize Latin terms when spelled in full. Spell out Latin terms on the first instance in a document. Do not italicize Latin abbreviations. Restrict use of Latin, if possible, by substituting with a commonly used word or phrase. Et cetera and etc. <br />
Italicize abbreviations <br />
Set common abbreviations in the font that you are using. Italicize abbreviations only if they stand for a term that would be italicized if spelled out—for example, a title of a book or journal. Do not italicize Latin abbreviations. (See also Latin Terms.)<br />
<br />
Example: Canadian Oxford Dictionary (COD); Journal of the American Medical Association (JAMA); ibid., etc., e.g., i.e. Note: Parentheses are not in italics. <br />
<br />
Articles (a, an, the) preceding an abbreviation<br />
When an abbreviation follows an indefinite article, choose a or an depending on the way the abbreviation sounds when read aloud. <br />
Example: an HMO, a UFO, a NATO member, an NBA coach, an HIV test, an MS symptom (a symptom of multiple sclerosis), a MS (would be read as “a manuscript by…”)<br />
<br />
Acronyms are read as words and, except when used adjectivally, are rarely preceded by a, an, or the.<br />
Example: member nations of NATO<br />
<br />
Initialisms are read as a series of letters and often are preceded by an article.<br />
Example: member nations of the EU<br />
<br />
Page / table / textual / References to non-OL materials [Revisit this …]<br />
In course documents / text, use page or pages, rather than p. or pp. In parenthetical references and reference lists, these abbreviations are acceptable.<br />
<br />
Spell out the textual reference in full, rather than using an abbreviated form. <br />
Example: page not p., figure not fig.<br />
<br />
<br />
Active Voice<br />
Use the active voice whenever possible, unless genre conventions specifically require the passive voice. Eliminate the passive voice whenever possible by replacing passive verbs with active verbs, converting nouns to verbs, and identifying the subject. Put the subject in front of the verb.<br />
<br />
In the active voice, the subject of the sentence acts; in the passive voice, the subject is acted upon. In other words, in the active voice, the subject performs an action, and in the passive voice, the subject receives the action of the verb.<br />
<br />
In the passive voice, the agent of the action often comes at the end of the sentence, or the agent is minimized, unnamed, or unknown. When you do not identify the agent performing the action, the meaning of the sentence is often ambiguous.<br />
Example of passive voice: The environmental damage was caused by the negligent oil company.<br />
Example of active voice: The negligent oil company caused the environmental damage.<br />
<br />
Passive Voice <br />
(See Active Voice)<br />
<br />
<br />
New material added from this point forward. <br />
<br />
Anthropomorphism <br />
<br />
Anthropomorphism attributes human qualities (or characteristics assumed to belong only to humans) to inanimate objects, non-living things, or abstract concepts such as organizations and governments. <br />
<br />
Avoid anthropomorphism whenever possible by not using the possessive case with inanimate objects, non-living things, or abstract concepts, since this construction implies that they can possess something.<br />
<br />
Example of anthropomorphism: The financial market’s impact on the 2008 recession was wide and deep.<br />
Correct version: The 2008 recession was widely and deeply impacted by the financial market. <br />
<br />
An exception to this guideline is the use of anthropomorphism as a literary device, for example, in fables or mythological traditions. Also, some philosophical strands of the environmental movement consider the Earth or Gia to be a living biological interdependent organism.<br />
<br />
In addition, animism is a set of beliefs that animals, plants, rocks, geographic features such as mountains and rivers, and other entities of the natural environment are conscious, spiritual beings, and that the physical and spiritual world are not separate dimensions. On the other hand, when someone assumes that only humans possess certain traits, this assumption is called anthropocentrism, which is a conscious or unconscious belief in human exceptionalism. For example, in The Descent of Man, Charles Darwin dismissed the idea of human exceptionalism by arguing that humans differ “only in degree, and not kind” from other living organisms. <br />
<br />
<br />
Apostrophe<br />
The possessive form of most singular common nouns and some pronouns is formed by adding an apostrophe followed by an s; in addition, an apostrophe followed by an s also is used to indicate the contraction of two words. <br />
Examples: the horse’s mouth, children’s literature, anyone’s guess, haven’t, it’s <br />
<br />
Use an apostrophe followed by an s to indicate the possessive form of singular proper nouns, even if they end in s, x, or z. Also, this general guideline applies to letter and numbers. <br />
Examples: Toronto’s lakefront, London’s Big Ben, Dickens’s novels, Marx’s economic theories, Robbie Burns’s poems, 1999’s worst storm, ABC’s of finance<br />
<br />
Some exceptions<br />
When a singular form of a noun that ends in s looks like a plural, and the plural form is the same as the singular, create the possessive of both the singular and plural by adding an apostrophe only. <br />
Examples: <br />
the species’ first emergence<br />
politics’ best function<br />
<br />
If this appears ambiguous, use of to avoid the possessive.<br />
<br />
Examples:<br />
the government of the United States rather than the United States’ government<br />
(this use also has the added advantage of not being an anthropomorphic construction) <br />
<br />
<br />
<br />
<br />
Appropriate Language<br />
Gender bias<br />
Gender-related bias privileges either the masculine or feminine gender when referring to both genders. When referring to both genders, the ideal is to use gender-neutral language. Editors and writers can achieve this ideal, but it takes thought and hard work. <br />
<br />
Do not use either he or she to represent both genders. When possible, within the bounds of clarity and making sense, use the plural pronoun rather than a singular gender-specific pronoun.<br />
<br />
Incorrect: The student logs on using his or her password.<br />
Correct: The student logs on using their password. <br />
<br />
Incorrect: Complete your initial draft after you enter her comments.<br />
Correct: Complete your initial draft after you enter the editor’s comments.<br />
<br />
Incorrect: man-hours<br />
Correct: work hours<br />
<br />
Incorrect: workman<br />
Correct: worker<br />
<br />
Incorrect: manpower<br />
Correct: staff, human resources<br />
<br />
<br />
Jargon and colloquialisms<br />
Avoid jargon and idiomatic or colloquial expressions. Jargon is the language used by people who work in a particular discipline or area, or who share a common interest. Since members of these groups use jargon as a kind of short-hand to express frequently discussed ideas in their area, it often becomes a barrier to communication for those not familiar with the ideas and language of these groups.<br />
<br />
Colloquialisms are words, phrases, or paralanguage employed in conversational or informal language, but should not be used in formal speech or formal writing. Colloquialisms often have a regional specificity. <br />
<br />
Examples of words: cool, y’all, wanna<br />
<br />
Examples of phrases: dead as a doornail (instead of deceased), raining cats and dogs (instead of a downpour)<br />
Examples of paralanguage: Usually, paralanguage is crucial to a work of written fiction and can be used in the following ways: 1) tags: for example “he hissed,” “she whispered”; 2) descriptions of all the things that people do with their bodies: laughing, sighing, sneezing, frowning, rolling their eyes, touching their face at various places, hand gestures, and so on.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
In the following list of items to be included in the Style Guide, those highlighted in yellow were added during our editorial meeting to discuss the style guide on Aug 1, 2012. <br />
<br />
<br />
● <br />
● Appropriate language<br />
● Articles<br />
● Bold text<br />
● Capitalization <br />
● Captions <br />
● Colon<br />
● Colloquialisms, idioms, non-standard English, slang<br />
● Comma<br />
● Concision<br />
● Contractions<br />
● Copyright notices<br />
● Dashes<br />
● Dates<br />
● Determiners<br />
● Direct address<br />
● Ellipsis<br />
● Figures and figure captions<br />
● Footnotes<br />
● Foreign terms<br />
● Gerunds<br />
● Headings<br />
● Hyperlinks<br />
● Hyphen<br />
● Italics<br />
● Lists<br />
● Latin terms (use sparingly)<br />
● Measurement conventions<br />
● Miscellaneous<br />
● Numbering<br />
● Parallelism<br />
● Parenthesis, brackets, and braces<br />
● Passive voice (see anthropomorphism for situations when passive voice is acceptable) <br />
● Per cent or %<br />
● Pet peeves <br />
● Plain English<br />
● Plurals<br />
● Positive statements<br />
● Precision <br />
● Procedures [click (v.), not click on]<br />
● Pronouns<br />
● Quotation marks<br />
● References<br />
● Repetition (Wordiness, concise instructions ??) <br />
● Semicolon<br />
● Slash<br />
● Spelling<br />
● Subject-verb agreement<br />
● Subordinate sentence structure <br />
● Tables<br />
● That and which <br />
● URLs<br />
● User interface terminology and style<br />
● Verb tense<br />
● Word choice <br />
● Would and will (added since Aug meeting)<br />
<br />
<br />
Note: Also write a procedure about how to use the comment tools in Acrobat Pro and Acrobat Reader.</div>MonaHall