CCS Cataloging Manual:Manual of Style - Revision history

Scrap at 20:59, 17 September 2018

2018-09-17T20:59:38Z

← Older revision		Revision as of 20:59, 17 September 2018
Line 1:		Line 1:
	The '''Manual of Style''' is a style guide for the CCS cataloging manual. ~~Please follow it~~ except where common sense and the occasional exception will improve an entry.		The '''Manual of Style''' is a style guide for the CCS cataloging manual. Its guidelines should be followed except where common sense and the occasional exception will improve an entry.

	==Naming conventions==		==Naming conventions==
Line 179:		Line 179:
	When the actual rules on an entire page have been approved, but the final wording for the manual is still being reviewed, or when an existing rule has been questioned and is being reconsidered but no final action has been taken yet, insert the [[Template:Review\|review template]] as the first line of the page. Use the date= parameter to indicate the date the change was tentatively approved.		When the actual rules on an entire page have been approved, but the final wording for the manual is still being reviewed, or when an existing rule has been questioned and is being reconsidered but no final action has been taken yet, insert the [[Template:Review\|review template]] as the first line of the page. Use the date= parameter to indicate the date the change was tentatively approved.

	When a ~~new or changed actual~~ rule within a larger page has been approved, but the final wording for the manual is still being reviewed, surround the ~~changed~~ text with the [[Template:Reviewbox\|reviewbox template]].		When a rule within a larger page has been approved, but the final wording for the manual is still being reviewed, surround the relevant text with the [[Template:Reviewbox\|reviewbox template]].

	When converting a "draft box" to a "review box", be sure to delete any duplicated original text as well as any text that had been struck through.		When converting a "draft box" to a "review box", be sure to delete any duplicated original text as well as any text that had been struck through.

	===Deletions & Obsolete Rules===		===Deletions & Obsolete Rules===
	When ~~someone proposes that~~ an entire page ~~be deleted from~~ the ~~manual~~, insert the [[Template:~~Delete~~\|~~delete~~ template]] as the first line of the page.		When an entire page has been declared obsolete but is retained in order to explain the reason why older data in the database looks the way it does, insert the [[Template:Obsolete\|obsolete template]] as the first line of the page.

	When an entire page has been declared obsolete but needs to be retained in order to explain the reason why older data in the database looks the way it does, insert the [[Template:Obsolete\|obsolete template]] as the first line of ~~the page.~~		When a section of a page has been declared obsolete but is retained for historical reasons, surround the text with the [[Template:Obsoletebox\|obsoletebox template]].

	~~When a particular rule within~~ a ~~larger~~ page has been declared obsolete but ~~needs to be~~ retained for historical reasons, surround the text with the [[Template:Obsoletebox\|obsoletebox template]].

	==Redirection==		==Redirection==

Scrap: /* References */

2018-09-17T20:53:36Z

References

← Older revision		Revision as of 20:53, 17 September 2018
Line 118:		Line 118:

	===References===		===References===
	If external resources are relevant to an entire page, use the [[Template:~~Example~~\|external template]] to put a short list of links in a box in the upper right corner of the page.		If external resources are relevant to an entire page, use the [[Template:External\|external template]] to put a short list of links in a box in the upper right corner of the page.

	For references to RDA or other rules, either cite the rule number directly in the text (e.g. "following RDA 2.3.1") or use a footnote in the form "RDA 2.3.1".		For references to RDA or other rules, either cite the rule number directly in the text (e.g. "following RDA 2.3.1") or use a footnote in the form "RDA 2.3.1".

Scrap: /* References */

2018-09-17T20:29:38Z

References

← Older revision		Revision as of 20:29, 17 September 2018
Line 118:		Line 118:

	===References===		===References===
	If an external ~~site is~~ relevant to an entire page, use a template to put a short list of links to in a box in the upper right corner of the page~~: <code>{{External\| * hyperlink }}</code>~~		If external resources are relevant to an entire page, use the [[Template:Example\|external template]] to put a short list of links in a box in the upper right corner of the page.

	For ~~inline~~ references to RDA or other rules, use footnote.		For references to RDA or other rules, either cite the rule number directly in the text (e.g. "following RDA 2.3.1") or use a footnote in the form "RDA 2.3.1".

	For ~~inline~~ references to CCS decisions, use a footnote in the form "CAMM, March 12, 2016".		For references to CCS decisions, use a footnote in the form "CAMM, March 12, 2016".

	==Formatting MARC data==		==Formatting MARC data==

Scrap at 20:09, 17 September 2018

2018-09-17T20:09:29Z

← Older revision		Revision as of 20:09, 17 September 2018
Line 19:		Line 19:
	Use the gerund (e.g. "editing" rather than "edit") of verbs unless there is a more common form that makes more sense in context.		Use the gerund (e.g. "editing" rather than "edit") of verbs unless there is a more common form that makes more sense in context.

	==~~First sentences~~==		==Content==
	===~~Content~~===		===First sentence===
	The first sentence should begin with a simple declarative sentence that summarizes the entry's subject matter.		The first sentence should begin with a simple declarative sentence that summarizes the entry's subject matter.

	If possible, the page title should appear once in the first sentence.		If possible, the page title should appear once in the first sentence.

	~~===Format===~~
	The first, and only the first, appearance of the page title should be in '''boldface'''.		The first, and only the first, appearance of the page title should be in '''boldface'''.

			===Referring to the database===
			Use "in the CCS database" instead of "in the local database" or "locally".

			===Citing other rules===
			If a specific RDA rule applies, the number may be cited, but do not link to it as rule numbers may be changed.

			Other guidelines (e.g. OCLC, OLAC, MLA) may be cited and/or linked as applicable.

			See [[#References\|References]] for formatting.

			===Citing CCS decisions===
			If a local practice is adopted by a CCS group (e.g. CAMM Technical Group), cite the group and date. See [[#References\|References]] for formatting.

			===General guidelines===
			Follow these general suggestions from [https://www.usability.gov/how-to-and-tools/methods/writing-for-the-web.html usability.gov]:

			* Use plain language when possible.
			* Chunk content into sections, to make it more scannable.
			* Use short sentences and paragraphs. The ideal standard is no more than 20 words per sentence, five sentences per paragraph.
			* Use bullets and numbered lists, and not just for long lists. One sentence and two bullets is often easier to read than three sentences.
			* Add keywords in sentences if that will help discovery. For example, instead of "Macros" consider using "OCLC Connexion Macros for WorldCat".
			* Use neutral, direct language. Instead of "Please remember to change", just use "Change".
			* Where applicable, use language similar to that of [https://www.oclc.org/bibformats/en.html OCLC Bibliographic Standards and Formats].

	==Text formatting==		==Text formatting==
Line 76:		Line 99:
	Use an en dash (–, entered as &ndash;) in the body text of entries as the typographical equivalent of the word ''through'': Many libraries have fiscal years that run July–June.		Use an en dash (–, entered as &ndash;) in the body text of entries as the typographical equivalent of the word ''through'': Many libraries have fiscal years that run July–June.

	Use a hyphen instead of an en dash in representations of MARC data: <code>504  Includes bibliographical references (p. 103-120).</code>		Use a hyphen instead of an en dash in representations of MARC data: <code>504  Includes bibliographical references (pages 103-120).</code>

	====Em dashes====		====Em dashes====
Line 93:		Line 116:
	===Tables===		===Tables===
	When using wiki markup to create a table, include the [[Template:Table\|table template]] at the end of the first line to style the table appropriately. If manual users will need to re-sort the table by any column, use the [[Template:Sortable\|sortable template]] instead.		When using wiki markup to create a table, include the [[Template:Table\|table template]] at the end of the first line to style the table appropriately. If manual users will need to re-sort the table by any column, use the [[Template:Sortable\|sortable template]] instead.

			===References===
			If an external site is relevant to an entire page, use a template to put a short list of links to in a box in the upper right corner of the page: <code>{{External\| * hyperlink }}</code>

			For inline references to RDA or other rules, use footnote.

			For inline references to CCS decisions, use a footnote in the form "CAMM, March 12, 2016".

	==Formatting MARC data==		==Formatting MARC data==
	===Referring to subfields===		===Referring to subfields===
	For ~~in-line~~ references to a particular subfield, use either: subfield a (written out) or &Dagger;a (entered as <code>&Dagger;a</code>).		For inline references to a particular subfield, use either: subfield a (written out) or &Dagger;a (entered as <code>&Dagger;a</code>).

	For examples of OCLC WorldCat data, use &Dagger;a via <code>&Dagger;a</code> for ~~in-line~~ text, or <code>{{[[Template:Subfield\|subfield]]{{pipe}}style=oclc{{pipe}}a}}</code> for MARC-format examples.		For examples of OCLC WorldCat data, use &Dagger;a via <code>&Dagger;a</code> for inline text, or <code>{{[[Template:Subfield\|subfield]]{{pipe}}style=oclc{{pipe}}a}}</code> for MARC-format examples.

	For examples of Polaris data, use &Dagger;a via <code>&Dagger;a</code> for ~~in-line~~ text, or <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code> for MARC-format examples.		For examples of Polaris data, use &Dagger;a via <code>&Dagger;a</code> for inline text, or <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code> for MARC-format examples.

	===Referring to MARC indicators===		===Referring to MARC indicators===
	For general ~~in-line~~ reference to the value of one of a field's MARC indicators, use the format "first indicator [of] ''indicator value''" (e.g. "first indicator 1" or "first indicator of 1"). Use "[space]" to indicate a blank indicator position.		For general inline reference to the value of one of a field's MARC indicators, use the format "first indicator [of] ''indicator value''" (e.g. "first indicator 1" or "first indicator of 1"). Use "[space]" to indicate a blank indicator position.

	For ~~in-line~~ references to the contents of a particular tag when an indicator has a specific value, use the MARC tag followed by a space and the indicator(s). Use "_" to indicate a blank first indicator value when there is a non-blank second indicator value. Omit the second indicator when it would be blank. (E.g. "245 14", "100 2", "264 _4")		For inline references to the contents of a particular tag when an indicator has a specific value, use the MARC tag followed by a space and the indicator(s). Use "_" to indicate a blank first indicator value when there is a non-blank second indicator value. Omit the second indicator when it would be blank. (E.g. "245 14", "100 2", "264 _4")

	For ~~in-line~~ references that take the form of a full-field example, follow the guidelines on [[#Excerpts\|excerpts]] .		For inline references that take the form of a full-field example, follow the guidelines on [[#Excerpts\|excerpts]] .

	===Excerpts===		===Excerpts===

Scrap at 17:41, 17 September 2018

2018-09-17T17:41:50Z

← Older revision		Revision as of 17:41, 17 September 2018
Line 96:		Line 96:
	==Formatting MARC data==		==Formatting MARC data==
	===Referring to subfields===		===Referring to subfields===
	~~In a general reference~~ to a particular ~~MARC~~ subfield, use either: subfield a (written out) or &Dagger;a (entered as <code>&Dagger;a</code>).		For in-line references to a particular subfield, use either: subfield a (written out) or &Dagger;a (entered as <code>&Dagger;a</code>).

	In examples of OCLC WorldCat data, use &Dagger;a, via <code>&Dagger;a</code> for in-line text or <code>{{[[Template:Subfield\|subfield]]{{pipe}}style=oclc{{pipe}}a}}</code> for MARC-format examples.		For examples of OCLC WorldCat data, use &Dagger;a via <code>&Dagger;a</code> for in-line text, or <code>{{[[Template:Subfield\|subfield]]{{pipe}}style=oclc{{pipe}}a}}</code> for MARC-format examples.

	In examples of ~~WorkFlows~~ data, use ~~{{pipe}}~~a (for in-line text), ~~entered as~~ <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code> for MARC-format examples.		For examples of Polaris data, use &Dagger;a via <code>&Dagger;a</code> for in-line text, or <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code> for MARC-format examples.

	===Referring to MARC indicators===		===Referring to MARC indicators===
	~~In a~~ general in-line reference to the value of one of a field's MARC indicators, use the format "first indicator [of] ''indicator value''". (E.g. "first indicator 1" or "~~second~~ indicator of 1"). Use "[space]" to indicate a blank indicator position.		For general in-line reference to the value of one of a field's MARC indicators, use the format "first indicator [of] ''indicator value''" (e.g. "first indicator 1" or "first indicator of 1"). Use "[space]" to indicate a blank indicator position.

	For in-line references ~~that of~~ the contents of a particular tag when ~~a particular~~ indicator has ~~the mentioned~~ value, use the MARC tag, followed by a space and the indicator(s). Use "_" to indicate a blank first indicator value when there is a non-blank second indicator value. Omit the second indicator when it would be blank. (E.g. "245 14", "100 2", ~~and~~ "264 _4")		For in-line references to the contents of a particular tag when an indicator has a specific value, use the MARC tag followed by a space and the indicator(s). Use "_" to indicate a blank first indicator value when there is a non-blank second indicator value. Omit the second indicator when it would be blank. (E.g. "245 14", "100 2", "264 _4")

	For in-line references that take the form of a full-field example, follow the guidelines on [[#Excerpts\|excerpts]] .		For in-line references that take the form of a full-field example, follow the guidelines on [[#Excerpts\|excerpts]] .
Line 131:		Line 131:
	245 10 Baseball, hot dogs, and apple pie /{{subfield\|c}}by John Smith.}}		245 10 Baseball, hot dogs, and apple pie /{{subfield\|c}}by John Smith.}}

	==Formatting ~~Unicorn~~ data==		==Formatting Polaris data==
	===Policy names===		===Policy names===
	Format policy names ~~in all uppercase letters,~~ surrounded by <code>...</code>. Use <tt>...</tt> instead in table columns that include only the policy name.		Format policy names surrounded by <code>...</code>. Use <tt>...</tt> instead in table columns that include only the policy name.

	===Policy types===		===Policy types===
	Do not capitalize the names of policy types, such as ''~~item~~ type'', ''~~item category 1~~'', etc.		Do not capitalize the names of policy types, such as ''material type'', ''shelf location'', etc.

	==Proposed changes and changes in progress==		==Proposed changes and changes in progress==

Scrap: /* Formatting MARC data */

2015-06-17T16:10:21Z

Formatting MARC data

← Older revision		Revision as of 16:10, 17 June 2015
Line 96:		Line 96:
	==Formatting MARC data==		==Formatting MARC data==
	===Referring to subfields===		===Referring to subfields===
	~~{{draftbox\|text=~~
	In a general reference to a particular MARC subfield, use either: subfield a (written out) or &Dagger;a (entered as <code>&Dagger;a</code>).		In a general reference to a particular MARC subfield, use either: subfield a (written out) or &Dagger;a (entered as <code>&Dagger;a</code>).

Line 102:		Line 101:

	In examples of WorkFlows data, use {{pipe}}a (for in-line text), entered as <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code> for MARC-format examples.		In examples of WorkFlows data, use {{pipe}}a (for in-line text), entered as <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code> for MARC-format examples.
	}}

	===Referring to MARC indicators===		===Referring to MARC indicators===
	~~{{draftbox\|text=~~
	In a general in-line reference to the value of one of a field's MARC indicators, use the format "first indicator [of] ''indicator value''". (E.g. "first indicator 1" or "second indicator of 1"). Use "[space]" to indicate a blank indicator position.		In a general in-line reference to the value of one of a field's MARC indicators, use the format "first indicator [of] ''indicator value''". (E.g. "first indicator 1" or "second indicator of 1"). Use "[space]" to indicate a blank indicator position.

Line 111:		Line 108:

	For in-line references that take the form of a full-field example, follow the guidelines on [[#Excerpts\|excerpts]] .		For in-line references that take the form of a full-field example, follow the guidelines on [[#Excerpts\|excerpts]] .
	}}

	===Excerpts===		===Excerpts===

Scrap: /* Excerpts */

2015-03-17T19:44:33Z

Excerpts

← Older revision		Revision as of 19:44, 17 March 2015
Line 114:		Line 114:

	===Excerpts===		===Excerpts===
	Surround with <code>...</code> any excerpts or examples that are inline within a larger paragraph. Use two spaces between the tag and the content when both indicators should be blank. Use a ~~space~~ for blank indicators and separate the indicators from the tag and the content with a single space when one or both indicators have a non-blank value. Examples:		Surround with <code>...</code> any excerpts or examples that are inline within a larger paragraph. Use two spaces between the tag and the content when both indicators should be blank. Use a "_" for blank indicators and separate the indicators from the tag and the content with a single space when one or both indicators have a non-blank value. Examples:
	* ''Include a note of <code>504 Includes bibliographical references.</code> to indicate the presence of citations in footnotes throughout the work.''		* ''Include a note of <code>504 Includes bibliographical references.</code> to indicate the presence of citations in footnotes throughout the work.''
	* ''When a Playaway record includes <code>710 2 Findaway world.</code>, delete that field.''		* ''When a Playaway record includes <code>710 2_ Findaway world.</code>, delete that field.''

	===Entire fields, multiple fields, and entire records===		===Entire fields, multiple fields, and entire records===

Scrap: /* Formatting MARC data */

2015-03-17T18:44:12Z

Formatting MARC data

← Older revision		Revision as of 18:44, 17 March 2015
Line 102:		Line 102:

	In examples of WorkFlows data, use {{pipe}}a (for in-line text), entered as <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code> for MARC-format examples.		In examples of WorkFlows data, use {{pipe}}a (for in-line text), entered as <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code> for MARC-format examples.
			}}

			===Referring to MARC indicators===
			{{draftbox\|text=
			In a general in-line reference to the value of one of a field's MARC indicators, use the format "first indicator [of] ''indicator value''". (E.g. "first indicator 1" or "second indicator of 1"). Use "[space]" to indicate a blank indicator position.

			For in-line references that of the contents of a particular tag when a particular indicator has the mentioned value, use the MARC tag, followed by a space and the indicator(s). Use "_" to indicate a blank first indicator value when there is a non-blank second indicator value. Omit the second indicator when it would be blank. (E.g. "245 14", "100 2", and "264 _4")

			For in-line references that take the form of a full-field example, follow the guidelines on [[#Excerpts\|excerpts]] .
	}}		}}

	===Excerpts===		===Excerpts===
	Surround with <code>...</code> any excerpts or examples that are inline within a larger paragraph.		Surround with <code>...</code> any excerpts or examples that are inline within a larger paragraph. Use two spaces between the tag and the content when both indicators should be blank. Use a space for blank indicators and separate the indicators from the tag and the content with a single space when one or both indicators have a non-blank value. Examples:
			* ''Include a note of <code>504 Includes bibliographical references.</code> to indicate the presence of citations in footnotes throughout the work.''
			* ''When a Playaway record includes <code>710 2 Findaway world.</code>, delete that field.''

	===Entire fields, multiple fields, and entire records===		===Entire fields, multiple fields, and entire records===

Kschmdt: /* Referring to subfields */

2015-01-20T22:26:26Z

Referring to subfields

← Older revision		Revision as of 22:26, 20 January 2015
Line 97:		Line 97:
	===Referring to subfields===		===Referring to subfields===
	{{draftbox\|text=		{{draftbox\|text=
	~~''(Summary of what should go here: When~~ to use "subfield a~~" vs.~~ &Dagger;a ~~vs. {{subfield\|color=black\|~~a}} )''		In a general reference to a particular MARC subfield, use either: subfield a (written out) or &Dagger;a (entered as <code>&Dagger;a</code>).

	In ~~a general reference to a particular MARC subfield~~, use ~~either: subfield a or~~ &Dagger;a (<code>&Dagger;a</code>).		In examples of OCLC WorldCat data, use &Dagger;a, via <code>&Dagger;a</code> for in-line text or <code>{{[[Template:Subfield\|subfield]]{{pipe}}style=oclc{{pipe}}a}}</code> for MARC-format examples.

	In examples of ~~OCLC WorldCat~~ data, use ~~&Dagger;a, via <code>&Dagger;~~a~~</code>~~ (for in-line text) or <code>{{[[Template:Subfield\|subfield]]~~{{pipe}}style=oclc~~{{pipe}}a}}</code> ~~(For~~ MARC-format examples.)		In examples of WorkFlows data, use {{pipe}}a (for in-line text), entered as <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code> for MARC-format examples.

	~~In examples of WorkFlows data, use <code>{{[[Template:Subfield\|subfield]]{{pipe}}a}}</code>~~
	}}		}}

Kschmdt: /* Referring to subfields */

2014-12-19T18:48:17Z

Referring to subfields

← Older revision		Revision as of 18:48, 19 December 2014
Line 96:		Line 96:
	==Formatting MARC data==		==Formatting MARC data==
	===Referring to subfields===		===Referring to subfields===
	{{draftbox\|text="~~Subfield~~ a" vs. &Dagger;a vs. {{subfield\|color=black\|a}}		{{draftbox\|text=
			''(Summary of what should go here: When to use "subfield a" vs. &Dagger;a vs. {{subfield\|color=black\|a}} )''

	In a general reference to a particular MARC subfield, use either: subfield a or &Dagger;a (<code>&Dagger;a</code>).		In a general reference to a particular MARC subfield, use either: subfield a or &Dagger;a (<code>&Dagger;a</code>).