KOI Wiki Best Practices: Difference between revisions

Editing & Commenting: Main contents of page done for now.
m Editing & Commenting: Fixing paragraph breaks
Line 13: Line 13:
When you're on a page and see something you want to edit, look to the top of the section or sub-section you are looking to edit. There are two links to the right of each heading: "edit" and "edit source."   
When you're on a page and see something you want to edit, look to the top of the section or sub-section you are looking to edit. There are two links to the right of each heading: "edit" and "edit source."   
[[File:Section_&_Subsection_headings.png|alt=A screenshot of the top of the Purpose, scope, and definitions section of the KOI Financial Policies and Procedures wiki page. The heading, "Purpose, scope, and definitions" and  the two subheadings, "Purpose" and "Recognition of Capitalism and Harm," each have links next to them that read "edit" and "edit source."|none|thumb|925x925px|A screenshot of the top of the Purpose, scope, and definitions section of the KOI Financial Policies and Procedures wiki page. The heading, "Purpose, scope, and definitions" and   the two subheadings, "Purpose" and "Recognition of Capitalism and Harm," each have links next to them that read "edit" and "edit source."]]
[[File:Section_&_Subsection_headings.png|alt=A screenshot of the top of the Purpose, scope, and definitions section of the KOI Financial Policies and Procedures wiki page. The heading, "Purpose, scope, and definitions" and  the two subheadings, "Purpose" and "Recognition of Capitalism and Harm," each have links next to them that read "edit" and "edit source."|none|thumb|925x925px|A screenshot of the top of the Purpose, scope, and definitions section of the KOI Financial Policies and Procedures wiki page. The heading, "Purpose, scope, and definitions" and   the two subheadings, "Purpose" and "Recognition of Capitalism and Harm," each have links next to them that read "edit" and "edit source."]]
If you select edit source, you'll see the wiki contents presented as plain text with mark-up instead of traditional formatting:  
If you select edit source, you'll see the wiki contents presented as plain text with mark-up instead of traditional formatting:  
[[File:Edit Source page.png|alt=A screenshot of the Edit Source wiki editor. It has the interface of a text editor. In the text box is the contents of the "Editing & Commenting" section and "Logging in" subsection of the "KOI Wiki Best Practices" page. The headings have equals signs on either end instead of any visible formatting difference between them and the rest of the text. Instead of images, the file names and alt text are written out. |none|thumb|1106x1106px|A screenshot of the Edit Source wiki editor. It has the interface of a text editor. In the text box is the contents of the "Editing & Commenting" section and "Logging in" subsection of the "KOI Wiki Best Practices" page. The headings have equals signs on either end instead of any visible formatting difference between them and the rest of the text. Instead of images, the file names and alt text are written out. ]]
[[File:Edit Source page.png|alt=A screenshot of the Edit Source wiki editor. It has the interface of a text editor. In the text box is the contents of the "Editing & Commenting" section and "Logging in" subsection of the "KOI Wiki Best Practices" page. The headings have equals signs on either end instead of any visible formatting difference between them and the rest of the text. Instead of images, the file names and alt text are written out. |none|thumb|1106x1106px|A screenshot of the Edit Source wiki editor. It has the interface of a text editor. In the text box is the contents of the "Editing & Commenting" section and "Logging in" subsection of the "KOI Wiki Best Practices" page. The headings have equals signs on either end instead of any visible formatting difference between them and the rest of the text. Instead of images, the file names and alt text are written out. ]]  


Selecting "edit" will bring you to a traditional text editor-type interface:  
Selecting "edit" will bring you to a traditional text editor-type interface:  
Line 24: Line 25:
After you've made your edits, you'll click on the "Save changes..." button in the top right of the page:  
After you've made your edits, you'll click on the "Save changes..." button in the top right of the page:  
[[File:Save Changes... Button.png|alt=A screenshot of the top right of the wiki Edit page. It features the Help icon (a question mark), the Options icon (a hamburger menu button), the drop-down for switching editing views (a pencil icon), and a blue Save changes... button. |none|frame|A screenshot of the top right of the wiki Edit page. It features the Help icon (a question mark), the Options icon (a hamburger menu button), the drop-down for switching editing views (a pencil icon), and a blue Save changes... button. ]]
[[File:Save Changes... Button.png|alt=A screenshot of the top right of the wiki Edit page. It features the Help icon (a question mark), the Options icon (a hamburger menu button), the drop-down for switching editing views (a pencil icon), and a blue Save changes... button. |none|frame|A screenshot of the top right of the wiki Edit page. It features the Help icon (a question mark), the Options icon (a hamburger menu button), the drop-down for switching editing views (a pencil icon), and a blue Save changes... button. ]]
If the Save changes button isn't blue, it's because you haven't made an edit yet.  
If the Save changes button isn't blue, it's because you haven't made an edit yet.  
Clicking Save changes... will bring you to a screen that asks you to record the reason for your edit:  
Clicking Save changes... will bring you to a screen that asks you to record the reason for your edit:  
Line 39: Line 41:
One of the options available while making an edit to a wiki page is leaving a comment. You can find that option under the "Insert" drop-down menu in the editor:  
One of the options available while making an edit to a wiki page is leaving a comment. You can find that option under the "Insert" drop-down menu in the editor:  
[[File:Insert drop-down menu.png|alt=A screenshot of the wiki Editor's Insert drop-down menu. It includes the options "Images and Media," "Template," "Table," "Comment," "Code Block," "Gallery," "Your signature" (which is grayed out), and "Reference list." |none|thumb|386x386px|A screenshot of the wiki Editor's Insert drop-down menu. It includes the options "Images and Media," "Template," "Table," "Comment," "Code Block," "Gallery," "Your signature" (which is grayed out), and "Reference list." ]]
[[File:Insert drop-down menu.png|alt=A screenshot of the wiki Editor's Insert drop-down menu. It includes the options "Images and Media," "Template," "Table," "Comment," "Code Block," "Gallery," "Your signature" (which is grayed out), and "Reference list." |none|thumb|386x386px|A screenshot of the wiki Editor's Insert drop-down menu. It includes the options "Images and Media," "Template," "Table," "Comment," "Code Block," "Gallery," "Your signature" (which is grayed out), and "Reference list." ]]
When you select the comment option, make sure your cursor is already in the location where you want to leave the comment:  
When you select the comment option, make sure your cursor is already in the location where you want to leave the comment:  
[[File:Comment Example 1 .png|alt=A screenshot of a the wiki Edit page. A pop-up window titled "Comment" features a blank text box and an arrow pointing to a cursor location on the editable text. |none|thumb|398x398px|A screenshot of a the wiki Edit page. A pop-up window titled "Comment" features a blank text box and an arrow pointing to a cursor location on the editable text. ]]
[[File:Comment Example 1 .png|alt=A screenshot of a the wiki Edit page. A pop-up window titled "Comment" features a blank text box and an arrow pointing to a cursor location on the editable text. |none|thumb|398x398px|A screenshot of a the wiki Edit page. A pop-up window titled "Comment" features a blank text box and an arrow pointing to a cursor location on the editable text. ]]
Enter the comment you wish to leave, click the "Insert" button in the top-right of the comment window, then finish the editing process as described above. Your comment will not appear on the main page itself, but will be visible to anyone who looks at the Editing view of the page. It will also appear in the list of other edits for users to view.  
Enter the comment you wish to leave, click the "Insert" button in the top-right of the comment window, then finish the editing process as described above. Your comment will not appear on the main page itself, but will be visible to anyone who looks at the Editing view of the page. It will also appear in the list of other edits for users to view.  
Important note: if you have a word or a portion of text selected when you make the comment, the comment will replace the highlighted material:  
Important note: if you have a word or a portion of text selected when you make the comment, the comment will replace the highlighted material:  
[[File:Comment replacing text.png|alt=A screenshot of the wiki Editor that shows a bullet point that has been replaced by a comment. The comment reads "Test comment."|none|frame|A screenshot of the wiki Editor that shows a bullet point that has been replaced by a comment. The comment reads "Test comment."]]
[[File:Comment replacing text.png|alt=A screenshot of the wiki Editor that shows a bullet point that has been replaced by a comment. The comment reads "Test comment."|none|frame|A screenshot of the wiki Editor that shows a bullet point that has been replaced by a comment. The comment reads "Test comment."]]