TechWiki:Manual of Style - Revision history

TimRiker at 20:53, 3 February 2022

2022-02-03T20:53:43Z

← Older revision		Revision as of 20:53, 3 February 2022
Line 1:		Line 1:
	The '''Manual of Style''', often abbreviated '''MoS''', is a [[wikipedia:style guide\|style guide]] for ~~Tech~~ articles. The guidelines here refer to style, not wiki formatting. For wiki formatting and other wiki-specific information, see [[TechWiki:Guidelines]].		The '''Manual of Style''', often abbreviated '''MoS''', is a [[wikipedia:style guide\|style guide]] for TechWiki articles. The guidelines here refer to style, not wiki formatting. For wiki formatting and other wiki-specific information, see [[TechWiki:Guidelines]].

	When it comes to writing technical content, we follow these style guides:		When it comes to writing technical content, we follow these style guides:
Line 1,220:		Line 1,220:
	"As we bear His holy priesthood worthily, we will be victorious."<br /><br />—President Thomas S. Monson		"As we bear His holy priesthood worthily, we will be victorious."<br /><br />—President Thomas S. Monson

	[[Category:~~Tech~~ Administration]]		[[Category:Administration]]

TimRiker: new domain

2019-11-15T18:47:34Z

new domain

← Older revision		Revision as of 18:47, 15 November 2019
Line 290:		Line 290:
	''Correct:''		''Correct:''

	Please send feedback about this system to '''feedback@~~ldschurch~~.org'''.		Please send feedback about this system to '''feedback@churchofjesuschrist.org'''.

	''Incorrect:''		''Incorrect:''
Line 593:		Line 593:

	''Correct'':		''Correct'':
	Send feedback to [mailto:tech@~~ldschurch~~.org tech@~~ldschurch~~.org]		Send feedback to [mailto:tech@churchofjesuschrist.org tech@churchofjesuschrist.org]

	Become familiar with Chapter 10 of the Church style guide, which treats computer and Internet terms. For additional terms, see [[#Technical terms and usage\|Technical terms and usage]].		Become familiar with Chapter 10 of the Church style guide, which treats computer and Internet terms. For additional terms, see [[#Technical terms and usage\|Technical terms and usage]].

TimRiker at 02:49, 24 March 2019

2019-03-24T02:49:32Z

← Older revision		Revision as of 02:49, 24 March 2019
Line 1:		Line 1:
	The '''Manual of Style''', often abbreviated '''MoS''', is a [[wikipedia:style guide\|style guide]] for ~~LDSTech~~ articles. The guidelines here refer to style, not wiki formatting. For wiki formatting and other wiki-specific information, see [[~~LDSTech~~:Guidelines]].		The '''Manual of Style''', often abbreviated '''MoS''', is a [[wikipedia:style guide\|style guide]] for Tech articles. The guidelines here refer to style, not wiki formatting. For wiki formatting and other wiki-specific information, see [[TechWiki:Guidelines]].

	When it comes to writing technical content, we follow these style guides:		When it comes to writing technical content, we follow these style guides:
Line 54:		Line 54:
	===Tone===		===Tone===

	The Microsoft Manual of Style says, "Tone defines the relationship between the writer and the reader" (p. 105). Because of the ~~LDSTech~~ platform, our audiences will likely regard them as official Church publications, sometimes even "gospel truth," so to speak.		The Microsoft Manual of Style says, "Tone defines the relationship between the writer and the reader" (p. 105). Because of the Tech platform, our audiences will likely regard them as official Church publications, sometimes even "gospel truth," so to speak.

	However, instructional products usually don't include scriptural passages or General Authority quotations. It isn't our job to pronounce Church doctrine, though we may need to include Church or department policy at times. The tone of our products should not be one of a person in authority telling others what to do.		However, instructional products usually don't include scriptural passages or General Authority quotations. It isn't our job to pronounce Church doctrine, though we may need to include Church or department policy at times. The tone of our products should not be one of a person in authority telling others what to do.
Line 350:		Line 350:
	Article titles and section headings should not use title case. The first letter of the title or heading is capitalized, and proper nouns are capitalized. Other words are not capitalized.		Article titles and section headings should not use title case. The first letter of the title or heading is capitalized, and proper nouns are capitalized. Other words are not capitalized.

	{{Note\|The style guidelines regarding capitalization for articles in the ~~LDSTech~~ Wiki are different from the rules for articles on LDS.org and other publications, which use title case as outlined in Chicago Manual of Style 8.167. This is because the ~~LDSTech~~ Wiki follows similar capitalization styles as Wikipedia.}}		{{Note\|The style guidelines regarding capitalization for articles in the Tech Wiki are different from the rules for articles on LDS.org and other publications, which use title case as outlined in Chicago Manual of Style 8.167. This is because the Tech Wiki follows similar capitalization styles as Wikipedia.}}

	===Collections of pages===		===Collections of pages===
Line 1,073:		Line 1,073:

	===LDS Technology Website ===		===LDS Technology Website ===
	The Church's technology website should be referenced as [http://tech.~~lds~~.org ~~LDSTech~~], or by its full name, "~~LDS~~ Technology Website." The entire URL is not needed. An external link should always be included at least once in the article. If referencing material on ~~LDSTech~~, contributors are encouraged to consider whether a direct link to the material, thread, post, or webpage is more appropriate than a link to the home page of ~~LDSTech~~ with navigation instructions. The {{tl\|~~LDSTech~~}} template can be used for references to threads and posts on the ~~LDSTech~~ forums.		The Church's technology website should be referenced as [http://tech.churchofjesuschrist.org Tech], or by its full name, "Technology Website." The entire URL is not needed. An external link should always be included at least once in the article. If referencing material on Tech, contributors are encouraged to consider whether a direct link to the material, thread, post, or webpage is more appropriate than a link to the home page of Tech with navigation instructions. The {{tl\|Tech}} template can be used for references to threads and posts on the Tech forums.

	=== Clerk and Technology Support ===		=== Clerk and Technology Support ===
Line 1,220:		Line 1,220:
	"As we bear His holy priesthood worthily, we will be victorious."<br /><br />—President Thomas S. Monson		"As we bear His holy priesthood worthily, we will be victorious."<br /><br />—President Thomas S. Monson

	[[Category:~~LDSTech~~ Administration]]		[[Category:Tech Administration]]

TimRiker at 20:07, 18 April 2016

2016-04-18T20:07:07Z

← Older revision		Revision as of 20:07, 18 April 2016
Line 924:		Line 924:

	===Meetinghouse===		===Meetinghouse===
	The word "meetinghouse" should not generally be capitalized when it is simply referring to a building in which members meet. However, the word can be used in proper noun phrases such as [[Meetinghouse Webcast]] or [[Meetinghouse Internet]]; in such cases, the word "Meetinghouse" should be capitalized, since those specific technologies are appropriately referenced as proper nouns.		The word "meetinghouse" should not generally be capitalized when it is simply referring to a building in which members meet. However, the word can be used in proper noun phrases such as [[Meetinghouse Webcast Communicator]] or [[Meetinghouse Internet]]; in such cases, the word "Meetinghouse" should be capitalized, since those specific technologies are appropriately referenced as proper nouns.

	===mobile===		===mobile===

Bobcarleski: /* Writing lists */

2012-04-21T14:13:43Z

Writing lists

← Older revision		Revision as of 14:13, 21 April 2012
Line 359:		Line 359:
	==Writing lists==		==Writing lists==

	Generally, use vertical lists rather than inline lists. Procedures are vertical lists. ~~Use~~ vertical lists when breaking parallel concepts into separate items will visually aid comprehension (for example, when each item is its own sentence or the list consists of three or more items).		Generally, use vertical lists rather than inline lists. Procedures are vertical lists. Using vertical lists when breaking parallel concepts into separate items will visually aid comprehension (for example, when each item is its own sentence or the list consists of three or more items).

	===Introducing lists===		===Introducing lists===

Johnsonth: adjusting headings

2012-03-26T21:47:50Z

adjusting headings

← Older revision		Revision as of 21:47, 26 March 2012
Line 811:		Line 811:
	''Click'' a link. Use no descriptor.		''Click'' a link. Use no descriptor.

	===Clickable icons===		====Clickable icons====

	''With accompanying text:'' If a clickable icon has a label, use that label when referring to the icon, followed by a sample of the icon. Use no descriptor.		''With accompanying text:'' If a clickable icon has a label, use that label when referring to the icon, followed by a sample of the icon. Use no descriptor.
Line 837:		Line 837:
	A modal window is basically a web version of a dialog box, so follow the rules above. Do not use the term ''pop-up window'' or ''pop-up'', which are separate browser windows typically used for ads on websites.		A modal window is basically a web version of a dialog box, so follow the rules above. Do not use the term ''pop-up window'' or ''pop-up'', which are separate browser windows typically used for ads on websites.

	===Tables===		====Tables====

	The heading over a table column is called a ''column head'' (see ''Chicago Manual of Style'' 13.3).		The heading over a table column is called a ''column head'' (see ''Chicago Manual of Style'' 13.3).

Aebrown: Fix formatting of examples to be consistently in

 tags; fix broken chunking link

2012-03-26T21:24:07Z

Fix formatting of examples to be consistently in <pre> tags; fix broken chunking link

← Older revision		Revision as of 21:24, 26 March 2012
Line 419:		Line 419:
	===Introducing procedures===		===Introducing procedures===

	Whenever possible, include an introductory paragraph in procedural topics. In almost all cases, the writer can provide some kind of context (why or when the task would or should be completed) or prerequisites. Keep the introduction focused on the specific task. Use concept topics to give general background information. See [[#~~Topics~~ and content chunking\|~~Topics~~ and content chunking]].		Whenever possible, include an introductory paragraph in procedural topics. In almost all cases, the writer can provide some kind of context (why or when the task would or should be completed) or prerequisites. Keep the introduction focused on the specific task. Use concept topics to give general background information. See [[#Articles and content chunking\|Articles and content chunking]].

	When you have introductory text, use a procedure heading between it and the procedure. Phrase the heading as an infinitive, and use no punctuation at the end. The procedure heading is unique among list introductions.		When you have introductory text, use a procedure heading between it and the procedure. Phrase the heading as an infinitive, and use no punctuation at the end. The procedure heading is unique among list introductions.
Line 617:		Line 617:
	''Example:''		''Example:''

	When finished, click '''Save'''.		When finished, click '''Save'''.

	===Pages, screens, and sections===		===Pages, screens, and sections===
Line 647:		Line 647:
	Text is ''typed'' into a field, not ''entered''. However, if you are referring to a form as a whole with multiple elements, it is appropriate to use ''enter'', as in "enter the requested information."		Text is ''typed'' into a field, not ''entered''. However, if you are referring to a form as a whole with multiple elements, it is appropriate to use ''enter'', as in "enter the requested information."

	If instructions tell the user exactly what to type in a field, use <~~nowiki></~~nowiki><pre~~><nowiki~~></nowiki> tags to set off the text. If the text to be inputted comes at the end of the step, put it on a new line (introduced by a colon) so that it is clear what should be typed.		If instructions tell the user exactly what to type in a field, use <nowiki><pre></nowiki> tags to set off the text. If the text to be inputted comes at the end of the step, put it on a new line (introduced by a colon) so that it is clear what should be typed.

	''Example:''		''Example:''

	In the Path box, type the following: ~~<br /><pre>~~C:/My Documents/Stuff/2011-statement.docx</pre>		<pre>In the Path box, type the following:
			C:/My Documents/Stuff/2011-statement.docx</pre>

	{{Note\|Do not use this style when the exact text to be typed isn't specified. For example, the instruction "Type your LDS Account username and password" does not use this style because the user name and password will be different for everyone.}}		{{Note\|Do not use this style when the exact text to be typed isn't specified. For example, the instruction "Type your LDS Account username and password" does not use this style because the user name and password will be different for everyone.}}

Johnsonth: made some more updates to this content

2012-03-26T20:41:50Z

made some more updates to this content

Show changes

Johnsonth: made some updates -- tried to remove references to specific styles

2012-03-26T17:56:25Z

made some updates -- tried to remove references to specific styles

Show changes

Aebrown: Make styling of "Example:" and "Exception:" consistent

2012-03-24T15:32:53Z

Make styling of "Example:" and "Exception:" consistent

← Older revision		Revision as of 15:32, 24 March 2012
Line 609:		Line 609:
	* Keys (on a keyboard)		* Keys (on a keyboard)

	'''Exception:''' Include a descriptor if confusion may result from leaving it out.		''Exception:'' Include a descriptor if confusion may result from leaving it out.

	===Label text===		===Label text===
Line 724:		Line 724:
	If referring to content or elements on a page viewed by clicking a tab, such as in an overview, write ''under'', not ''on'', the tab. The only things on the tabs themselves are text and sometimes icons. Referring to the elements as ''on'' the tab may be unclear for nontechnical audiences.		If referring to content or elements on a page viewed by clicking a tab, such as in an overview, write ''under'', not ''on'', the tab. The only things on the tabs themselves are text and sometimes icons. Referring to the elements as ''on'' the tab may be unclear for nontechnical audiences.

	'''Example:'''		''Example:''

	Under the Temple Profile tab, you manage the temple's basic information.		Under the Temple Profile tab, you manage the temple's basic information.