Adding Documentation to the Wiki - Revision history

Tgriego at 20:11, 17 May 2019

2019-05-17T20:11:37Z

← Older revision		Revision as of 20:11, 17 May 2019
Line 1:		Line 1:
	== Getting the Documentation Ready ==		== NOTICE ==
			This page is deprecated because of the addition of VisualEditor. If you're a heathen like [[User:Bsanders]] and use Source Editor, this page will help you with that.

			==Getting the Documentation Ready==
	Before you start transferring your documentation over, you'll want to make sure it's written first. Ideally, to keep things clean here, your documentation should be split into sections with formal topic names. For instance, if you were documenting how to make a peanut butter and jelly sandwich, you would want to have something like:		Before you start transferring your documentation over, you'll want to make sure it's written first. Ideally, to keep things clean here, your documentation should be split into sections with formal topic names. For instance, if you were documenting how to make a peanut butter and jelly sandwich, you would want to have something like:

Line 27:		Line 30:


	== Transferring it to the Wiki (the fun part) ==		==Transferring it to the Wiki (the fun part)==
	Assuming you've written out your documentation, it's quite easy to transfer over to the wiki. First and foremost, you want to be logged in. In the top right corner (if you're not already logged in) there will be blue text that says "Log in". Click it, and if you need your credentials just come up to me (Tyler) and ask. After that, find your way to the search bar in the same cozy top right corner as before and search for what you want your article to be titled.		Assuming you've written out your documentation, it's quite easy to transfer over to the wiki. First and foremost, you want to be logged in. In the top right corner (if you're not already logged in) there will be blue text that says "Log in". Click it, and if you need your credentials just come up to me (Tyler) and ask. After that, find your way to the search bar in the same cozy top right corner as before and search for what you want your article to be titled.

Line 35:		Line 38:


	== Formatting the Page ==		==Formatting the Page==
	Everyone contributing should aim for consistent and high quality pages. We want this because not only would it make 24PinTech look good, but we can also eventually be established as a credible source for tech related guides/information outside of the city. With that out of the way, here's the good stuff:		Everyone contributing should aim for consistent and high quality pages. We want this because not only would it make 24PinTech look good, but we can also eventually be established as a credible source for tech related guides/information outside of the city. With that out of the way, here's the good stuff:

Line 41:		Line 44:

	What '''not''' to do when formatting/proofreading:		What '''not''' to do when formatting/proofreading:
	* paste an unformatted document and publish it
	* *use numbered lists for the entire document
	* include broken links
	* leave major grammar errors in your writing
	* forget to proofread

	''* = To elaborate: despite numbered lists being straightforward, they look pretty lazy (which we don't want). There are certain exceptions (like when you need to include how to get somewhere, use a certain command/program, et cetera), but just try to avoid using them overall.		*paste an unformatted document and publish it
			<nowiki>use numbered lists for the entire document</nowiki>
			*include broken links
			*leave major grammar errors in your writing
			*forget to proofread

			''* = To elaborate: despite numbered lists being straightforward, they look pretty lazy (which we don't want). There are certain exceptions (like when you need to include how to get somewhere, use a certain command/program, et cetera), but just try to avoid using them overall.''

	What '''to''' do when formatting:		What '''to''' do when formatting:
	* the contrary of everything above

	=== Actual Text Formatting ===		*the contrary of everything above

			===Actual Text Formatting===
	Here's a really summarized version for what you'll need by me:		Here's a really summarized version for what you'll need by me:

	* Escape wiki markup: <pre><nowiki><nowiki>''no formatting!'' '''''owo'''''</nowiki></nowiki></pre>		*Escape wiki markup: <pre><nowiki><nowiki>''no formatting!'' '''''owo'''''</nowiki></nowiki></pre>
	* New section: <pre>== Section Title ==</pre>		*New section: <pre>== Section Title ==</pre>
	* New subsection: <pre>(inside of a section) == Subsection Title ==</pre>		*New subsection: <pre>(inside of a section) == Subsection Title ==</pre>
	* Bold text: <pre>'''bold!'''</pre>		*Bold text: <pre>'''bold!'''</pre>
	* Italic text: <pre>''italics!''</pre>		*Italic text: <pre>''italics!''</pre>
	* Bold and italic text: <pre>'''''bold and italic!'''''</pre>		*Bold and italic text: <pre>'''''bold and italic!'''''</pre>
	* Bulleted list: <pre>* Start each line with an asterisk, to go deeper start the nextline with 1 more than the previous</pre>		Bulleted list: <pre> Start each line with an asterisk, to go deeper start the nextline with 1 more than the previous</pre>
	* Horizontal line: <pre>----</pre>		*Horizontal line: <pre>----</pre>
	* External link: <pre>[https://google.com Google]</pre> (shows up as [https://google.com Google])		*External link: <pre>[https://google.com Google]</pre> (shows up as [https://google.com Google])
	* Internal link: <pre>[[Title of Wiki Article]]</pre> (shows up as [[Title of Wiki Article]])		*Internal link: <pre>[[Title of Wiki Article]]</pre> (shows up as [[Title of Wiki Article]])

	=== Tables ===		===Tables===
	A brief documentation of creating tables would be impossible due to how broad and detailed you can make them. MediaWiki provides excellent documentation on it which can be found [https://www.mediawiki.org/wiki/Help:Tables here].		A brief documentation of creating tables would be impossible due to how broad and detailed you can make them. MediaWiki provides excellent documentation on it which can be found [https://www.mediawiki.org/wiki/Help:Tables here].

	=== Images ===		===Images===
	For images, I moved this to a subsection so it can properly be displayed on how to use them. First and foremost, any and all questions you have on embedding images into your wiki posts can be found [https://www.mediawiki.org/wiki/Help:Images here], but below is a brief rundown.		For images, I moved this to a subsection so it can properly be displayed on how to use them. First and foremost, any and all questions you have on embedding images into your wiki posts can be found [https://www.mediawiki.org/wiki/Help:Images here], but below is a brief rundown.

Line 84:		Line 89:
	[[File:Dogs.jpg]]		[[File:Dogs.jpg]]

	=== Full Documentation ===		===Full Documentation===
	For MediaWiki's ''full'' documentation of how to format, click [https://www.mediawiki.org/wiki/Help:Formatting here].		For MediaWiki's ''full'' documentation of how to format, click [https://www.mediawiki.org/wiki/Help:Formatting here].

	== Example of a Formatted Article ==		==Example of a Formatted Article==
	If you're still confused on what was covered earlier, an example using the aforementioned analogy with PB&J's is below.		If you're still confused on what was covered earlier, an example using the aforementioned analogy with PB&J's is below.

Tgriego at 20:01, 12 December 2017

2017-12-12T20:01:58Z

← Older revision		Revision as of 20:01, 12 December 2017
Line 58:		Line 58:
	* New section: <pre>== Section Title ==</pre>		* New section: <pre>== Section Title ==</pre>
	* New subsection: <pre>(inside of a section) == Subsection Title ==</pre>		* New subsection: <pre>(inside of a section) == Subsection Title ==</pre>
	* Bold text: <pre>''bold!''</pre>		* Bold text: <pre>'''bold!'''</pre>
	* Italic text: <pre>'''italics!'''</pre>		* Italic text: <pre>''italics!''</pre>
	* Bold and italic text: <pre>'''''bold and italic!'''''</pre>		* Bold and italic text: <pre>'''''bold and italic!'''''</pre>
	* Bulleted list: <pre>* Start each line with an asterisk, to go deeper start the nextline with 1 more than the previous</pre>		* Bulleted list: <pre>* Start each line with an asterisk, to go deeper start the nextline with 1 more than the previous</pre>

Tgriego at 20:24, 4 December 2017

2017-12-04T20:24:51Z

← Older revision		Revision as of 20:24, 4 December 2017
Line 72:		Line 72:
	For images, I moved this to a subsection so it can properly be displayed on how to use them. First and foremost, any and all questions you have on embedding images into your wiki posts can be found [https://www.mediawiki.org/wiki/Help:Images here], but below is a brief rundown.		For images, I moved this to a subsection so it can properly be displayed on how to use them. First and foremost, any and all questions you have on embedding images into your wiki posts can be found [https://www.mediawiki.org/wiki/Help:Images here], but below is a brief rundown.

	To begin, start by [[Special:Upload ~~uploading your file~~]] to the ~~wiki. Give it~~ a name you can remember. For instance, if I were embedding an image of dogs, I would want to go to [[Special:Upload ~~the upload page~~]] and upload the file and name it something like: <pre>dogs.jpg</pre>		To begin, start by going to the file upload page ([[Special:Upload]]). Be sure to give it [the file] a name you can remember. For instance, if I were embedding an image of dogs, I would want to go to the upload page ([[Special:Upload]]) and upload the file and name it something like: <pre>dogs.jpg</pre>

	[[File:Upload example.png]]		[[File:Upload example.png]]

Tgriego: /* Actual Text Formatting */

2017-12-04T20:21:52Z

Actual Text Formatting

@@ Line 64: / Line 64: @@
 * Horizontal line: <pre>----</pre>
 * External link: <pre>[https://google.com Google]</pre> (shows up as [https://google.com Google])
-'''Tables:''' A brief documentation of creating tables would be impossible due to how broad and detailed you can make them. MediaWiki provides excellent documentation on it which can be found [https://www.mediawiki.org/wiki/Help:Tables here].
+=== Tables ===
 For MediaWiki's ''full'' documentation of how to format, click [https://www.mediawiki.org/wiki/Help:Formatting here].

Tgriego: /* Actual Text Formatting */

2017-12-04T20:11:04Z

Actual Text Formatting

← Older revision		Revision as of 20:11, 4 December 2017
Line 65:		Line 65:
	* External link: <pre>[https://google.com Google]</pre> (shows up as [https://google.com Google])		* External link: <pre>[https://google.com Google]</pre> (shows up as [https://google.com Google])

	'''Tables'''		'''Tables:''' A brief documentation of creating tables would be impossible due to how broad and detailed you can make them. MediaWiki provides excellent documentation on it which can be found [https://www.mediawiki.org/wiki/Help:Tables here].

	A brief documentation of creating tables would be impossible due to how broad and detailed you can make them. MediaWiki provides excellent documentation on it which can be found [https://www.mediawiki.org/wiki/Help:Tables here].

	For MediaWiki's ''full'' documentation of how to format, click [https://www.mediawiki.org/wiki/Help:Formatting here].		For MediaWiki's ''full'' documentation of how to format, click [https://www.mediawiki.org/wiki/Help:Formatting here].

Tgriego: /* Actual Text Formatting */

2017-12-04T20:10:38Z

Actual Text Formatting

← Older revision		Revision as of 20:10, 4 December 2017
Line 66:		Line 66:

	'''Tables'''		'''Tables'''

	A brief documentation of creating tables would be impossible due to how broad and detailed you can make them. MediaWiki provides excellent documentation on it which can be found [https://www.mediawiki.org/wiki/Help:Tables here].		A brief documentation of creating tables would be impossible due to how broad and detailed you can make them. MediaWiki provides excellent documentation on it which can be found [https://www.mediawiki.org/wiki/Help:Tables here].

Tgriego: /* Actual Text Formatting */

2017-12-04T20:10:29Z

Actual Text Formatting

← Older revision		Revision as of 20:10, 4 December 2017
Line 64:		Line 64:
	* Horizontal line: <pre>----</pre>		* Horizontal line: <pre>----</pre>
	* External link: <pre>[https://google.com Google]</pre> (shows up as [https://google.com Google])		* External link: <pre>[https://google.com Google]</pre> (shows up as [https://google.com Google])

			'''Tables'''
			A brief documentation of creating tables would be impossible due to how broad and detailed you can make them. MediaWiki provides excellent documentation on it which can be found [https://www.mediawiki.org/wiki/Help:Tables here].

	For MediaWiki's ''full'' documentation of how to format, click [https://www.mediawiki.org/wiki/Help:Formatting here].		For MediaWiki's ''full'' documentation of how to format, click [https://www.mediawiki.org/wiki/Help:Formatting here].


	== Example of a Formatted Article ==		== Example of a Formatted Article ==

Tgriego at 20:07, 4 December 2017

2017-12-04T20:07:44Z

← Older revision		Revision as of 20:07, 4 December 2017
Line 76:		Line 76:

	For more information on the nutritional benefits of a sandwich, [http://healthyeating.sfgate.com/benefits-peanut-butter-jelly-sandwiches-5553.html click here].		For more information on the nutritional benefits of a sandwich, [http://healthyeating.sfgate.com/benefits-peanut-butter-jelly-sandwiches-5553.html click here].


	== Preparing the Ingredients ==		== Preparing the Ingredients ==
	Preparing the ingredients to make a PB&J is quite simple. All you need is 2 slices of bread and a sufficient amount of peanut butter and jelly (or jam) for the bread. If you don't have these ingredients you can either go to a [https://www.google.com/search?q=grocery+stores+near+me nearby grocery store] or shop online from a place like [https://amazon.com/ Amazon].		Preparing the ingredients to make a PB&J is quite simple. All you need is 2 slices of bread and a sufficient amount of peanut butter and jelly (or jam) for the bread. If you don't have these ingredients you can either go to a [https://www.google.com/search?q=grocery+stores+near+me nearby grocery store] or shop online from a place like [https://amazon.com/ Amazon].


	== Acquiring Proper Utensils ==		== Acquiring Proper Utensils ==
Line 89:		Line 87:

	You can also get those [https://amazon.com/ online] or from a [https://www.google.com/search?q=grocery+stores+near+me local grocery store].		You can also get those [https://amazon.com/ online] or from a [https://www.google.com/search?q=grocery+stores+near+me local grocery store].


	== Making the Sandwich ==		== Making the Sandwich ==
Line 105:		Line 102:
	== Enjoying the Meal ==		== Enjoying the Meal ==
	You're finally completed with the extraneous process of making a PB&J! All you have to do now is eat and enjoy it.		You're finally completed with the extraneous process of making a PB&J! All you have to do now is eat and enjoy it.

	</pre>		</pre>

	You can find this example here: [[Making a Peanut Butter & Jelly Sandwich]]		You can find this example here: [[Making a Peanut Butter & Jelly Sandwich]]

Tgriego at 20:07, 4 December 2017

2017-12-04T20:07:07Z

← Older revision		Revision as of 20:07, 4 December 2017
Line 107:		Line 107:

	</pre>		</pre>

			You can find this example here: [[Making a Peanut Butter & Jelly Sandwich]]

Tgriego at 20:04, 4 December 2017

2017-12-04T20:04:36Z

← Older revision		Revision as of 20:04, 4 December 2017
Line 101:		Line 101:
	Depending on who you are, you will like different side dishes with your completed PB&J sandwich (if any at all). Some people like chips, others like fruits, and some eat it with spaghetti or other miscellaneous pastas. It entirely depends on who you are, and this is up to you. Looking around your kitchen/house for various foods or edible objects can help inspire you with ideas.		Depending on who you are, you will like different side dishes with your completed PB&J sandwich (if any at all). Some people like chips, others like fruits, and some eat it with spaghetti or other miscellaneous pastas. It entirely depends on who you are, and this is up to you. Looking around your kitchen/house for various foods or edible objects can help inspire you with ideas.

			A link to this example can be found [http://10.21.25.11/wiki/index.php/Making_a_Peanut_Butter_%26_Jelly_Sandwich here].

	== Enjoying the Meal ==		== Enjoying the Meal ==