Gospel Translations:Formatting

From Gospel Translations

(Difference between revisions)
Jump to:navigation, search
m (Protected "GospelTranslations:Formatting" [edit=sysop:move=sysop])
Line 1: Line 1:
-
= Wiki Uploading and Formatting Guide =
+
= Wiki Uploading and Formatting Guide =
-
There are two modes within wiki editing. One is the “WYSIWYG mode”— an acronym for “What You See Is What You Get.” The other is the “Wikitext mode”. Most of your work will be done in the WYSIWYG mode, as that is usually the simplest for those of us who aren’t too familiar with wiki coding. The WYSIWYG mode is the one that will come up first when you go into edit mode. In order to switch to Wikitext mode you have to click the “Wikitext” button in the top left.
+
There are two modes within wiki editing. One is the “WYSIWYG mode”— an acronym for “What You See Is What You Get.” The other is the “Wikitext mode”. Most of your work will be done in the WYSIWYG mode, as that is usually the simplest for those of us who aren’t too familiar with wiki coding. The WYSIWYG mode is the one that will come up first when you go into edit mode. In order to switch to Wikitext mode you have to click the “Wikitext” button in the top left.  
-
=== How to Upload an Article/Book ===
+
=== How to Upload an Article/Book ===
-
# Create an account for yourself or log in at GospelTranslations.org by clicking on the button (log in/create account) in the top, right-hand corner of the screen.
+
#Create an account for yourself or log in at GospelTranslations.org by clicking on the button (log in/create account) in the top, right-hand corner of the screen.  
-
# Go to the link that OSM has given you for your article/chapter. 
+
#Go to the link that OSM has given you for your article/chapter.   
-
# Once you are there, click on the “edit” tab at the top of the page, and cut and paste your text into the formatting area.
+
#Once you are there, click on the “edit” tab at the top of the page, and cut and paste your text into the formatting area.  
-
# Use the English version as a reference for how to format the article/chapter and insert proper paragraph spacing, blockquotes, headings, and bolded and italicized text.
+
#Use the English version as a reference for how to format the article/chapter and insert proper paragraph spacing, blockquotes, headings, and bolded and italicized text.  
-
# When finished, hit “Show Preview” at the bottom of the formatting box to take a look at how the page is turning out.
+
#When finished, hit “Show Preview” at the bottom of the formatting box to take a look at how the page is turning out.  
-
# Finally, make sure to click the “Save Page” button when you are done, and notify OSM that the upload is complete.
+
#Finally, make sure to click the “Save Page” button when you are done, and notify OSM that the upload is complete.
-
=== Creating Footnotes/References ===
+
=== Creating Footnotes/References ===
-
# Find the button on the menu bar that looks like <R> and says "Insert/Edit Reference."
+
#Find the button on the menu bar that looks like <R> and says "Insert/Edit Reference."  
-
# Insert the footnote info into the box that it brings up. In order to italicize a book title you will need to surround it with two tick marks (i.e. ''God's Words'' = ''God's Words'').
+
#Insert the footnote info into the box that it brings up. In order to italicize a book title you will need to surround it with two tick marks (i.e. <nowiki>''God's Words''</nowiki> = ''God's Words'').  
-
# Go to the bottom of the page and type &lt;references /&gt;. This should create the footnotes for you.
+
#Go to the bottom of the page and type &lt;references /&gt;. This should create the footnotes for you.
-
=== Inserting Callout Boxes ===
+
=== Inserting Callout Boxes ===
-
Some of the books contain boxes with application questions, quotes, etc. that also need to be uploaded along with the main body of text. (For an example, take a look at chapter one of [[This Great Salvation/1|''This Great Salvation'']].) Instructions for inserting these are available [[Help:Inserting callout boxes|here]]. If you find this process to be too complicated then here is an alternate option:
+
Some of the books contain boxes with application questions, quotes, etc. that also need to be uploaded along with the main body of text. (For an example, take a look at chapter one of [[This Great Salvation/1|''This Great Salvation'']].) Instructions for inserting these are available [[Help:Inserting callout boxes|here]]. If you find this process to be too complicated then here is an alternate option:  
-
# Include the text from a callout box within the main body of text.
+
#Include the text from a callout box within the main body of text.  
-
# Bracket the text with _StartBox_ and _EndBox_.
+
#Bracket the text with _StartBox_ and _EndBox_.  
-
# For example, “'''Meditate on Hebrews 10:19-24'''. What gives us the confidence to stand in God's holy presence?” should be entered as:
+
#For example, “'''Meditate on Hebrews 10:19-24'''. What gives us the confidence to stand in God's holy presence?” should be entered as:
<blockquote>_StartBox_ '''Meditate on Hebrews 10:19-24'''. What gives us the confidence to stand in God's holy presence?_EndBox_</blockquote>  
<blockquote>_StartBox_ '''Meditate on Hebrews 10:19-24'''. What gives us the confidence to stand in God's holy presence?_EndBox_</blockquote>  
-
== FAQ ==
+
== FAQ ==
-
'''Q:''' I’m getting a “Contents” box at the top of my article that lists the contents of the article. <br>'''A:''' The wiki will automatically insert this if your article contains a particular number of headers within the text. In order to remove this simply insert __NOTC__ at the top of the page, and it should go away.
+
'''Q:''' I’m getting a “Contents” box at the top of my article that lists the contents of the article. <br>'''A:''' The wiki will automatically insert this if your article contains a particular number of headers within the text. In order to remove this simply insert __NOTC__ at the top of the page, and it should go away.  
-
'''Q:''' Every time I hit “Save” or “Show Preview” portions of the text appear bolded or italicized that should not be and/or there are tick marks appearing at various places throughout the article.<br>'''A:''' See answer under Troubleshooting section.
+
'''Q:''' Every time I hit “Save” or “Show Preview” portions of the text appear bolded or italicized that should not be and/or there are tick marks appearing at various places throughout the article.<br>'''A:''' See answer under Troubleshooting section.  
-
== Troubleshooting ==
+
== Troubleshooting ==
-
==== Paragraph Spacing ====
+
==== Paragraph Spacing ====
-
Spacing and line breaks can be tricky to figure out within the WYSIWYG mode. Here’s a tip:
+
Spacing and line breaks can be tricky to figure out within the WYSIWYG mode. Here’s a tip:  
-
* Place your cursor at the end of the sentence directly preceding where you want to insert a line break between paragraphs.
+
*Place your cursor at the end of the sentence directly preceding where you want to insert a line break between paragraphs.  
-
* Hit the delete button to get rid of all extra space.
+
*Hit the delete button to get rid of all extra space.  
-
* Do a hard return, and you should be left with the right amount of space.
+
*Do a hard return, and you should be left with the right amount of space.
-
==== Text Formatting ====
+
==== Text Formatting ====
-
You may run into trouble when you start making portions of the text bold and/or italicized. Headings that need to be bolded or italicized often seem to take a portion of the paragraph that follows with them. I've found that after hitting the “Show Preview” or “Save Page” button little apostrophes or tick marks (') will often insert themselves within the text and those end up messing up the formatting.
+
You may run into trouble when you start making portions of the text bold and/or italicized. Headings that need to be bolded or italicized often seem to take a portion of the paragraph that follows with them. I've found that after hitting the “Show Preview” or “Save Page” button little apostrophes or tick marks (') will often insert themselves within the text and those end up messing up the formatting.  
-
For example, if you were going to do all the formatting in Wikitext mode rather than WYSIWYG you'd need to insert three tick marks <nowiki>(''')</nowiki> before and after the text that you'd want to be bold. For example: <nowiki>'''OSM'''</nowiki> would result in '''OSM'''. For italics you would use two tick marks, so <nowiki>''OSM''</nowiki> would result in ''OSM.'' The key is to make sure to remove any of those little marks you see showing up in the text and take out any extra spaces. That usually fixes it, but it at times it can take several tries. If you still have trouble just let us know.
+
For example, if you were going to do all the formatting in Wikitext mode rather than WYSIWYG you'd need to insert three tick marks <nowiki>(''')</nowiki> before and after the text that you'd want to be bold. For example: <nowiki>'''OSM'''</nowiki> would result in '''OSM'''. For italics you would use two tick marks, so <nowiki>''OSM''</nowiki> would result in ''OSM.'' The key is to make sure to remove any of those little marks you see showing up in the text and take out any extra spaces. That usually fixes it, but it at times it can take several tries. If you still have trouble just let us know.  
<br>
<br>

Revision as of 16:15, 15 April 2008

Contents

Wiki Uploading and Formatting Guide

There are two modes within wiki editing. One is the “WYSIWYG mode”— an acronym for “What You See Is What You Get.” The other is the “Wikitext mode”. Most of your work will be done in the WYSIWYG mode, as that is usually the simplest for those of us who aren’t too familiar with wiki coding. The WYSIWYG mode is the one that will come up first when you go into edit mode. In order to switch to Wikitext mode you have to click the “Wikitext” button in the top left.

How to Upload an Article/Book

  1. Create an account for yourself or log in at GospelTranslations.org by clicking on the button (log in/create account) in the top, right-hand corner of the screen.
  2. Go to the link that OSM has given you for your article/chapter. 
  3. Once you are there, click on the “edit” tab at the top of the page, and cut and paste your text into the formatting area.
  4. Use the English version as a reference for how to format the article/chapter and insert proper paragraph spacing, blockquotes, headings, and bolded and italicized text.
  5. When finished, hit “Show Preview” at the bottom of the formatting box to take a look at how the page is turning out.
  6. Finally, make sure to click the “Save Page” button when you are done, and notify OSM that the upload is complete.

Creating Footnotes/References

  1. Find the button on the menu bar that looks like <R> and says "Insert/Edit Reference."
  2. Insert the footnote info into the box that it brings up. In order to italicize a book title you will need to surround it with two tick marks (i.e. ''God's Words'' = God's Words).
  3. Go to the bottom of the page and type <references />. This should create the footnotes for you.

Inserting Callout Boxes

Some of the books contain boxes with application questions, quotes, etc. that also need to be uploaded along with the main body of text. (For an example, take a look at chapter one of This Great Salvation.) Instructions for inserting these are available here. If you find this process to be too complicated then here is an alternate option:

  1. Include the text from a callout box within the main body of text.
  2. Bracket the text with _StartBox_ and _EndBox_.
  3. For example, “Meditate on Hebrews 10:19-24. What gives us the confidence to stand in God's holy presence?” should be entered as:
_StartBox_ Meditate on Hebrews 10:19-24. What gives us the confidence to stand in God's holy presence?_EndBox_

FAQ

Q: I’m getting a “Contents” box at the top of my article that lists the contents of the article.
A: The wiki will automatically insert this if your article contains a particular number of headers within the text. In order to remove this simply insert __NOTC__ at the top of the page, and it should go away.

Q: Every time I hit “Save” or “Show Preview” portions of the text appear bolded or italicized that should not be and/or there are tick marks appearing at various places throughout the article.
A: See answer under Troubleshooting section.

Troubleshooting

Paragraph Spacing

Spacing and line breaks can be tricky to figure out within the WYSIWYG mode. Here’s a tip:

Text Formatting

You may run into trouble when you start making portions of the text bold and/or italicized. Headings that need to be bolded or italicized often seem to take a portion of the paragraph that follows with them. I've found that after hitting the “Show Preview” or “Save Page” button little apostrophes or tick marks (') will often insert themselves within the text and those end up messing up the formatting.

For example, if you were going to do all the formatting in Wikitext mode rather than WYSIWYG you'd need to insert three tick marks (''') before and after the text that you'd want to be bold. For example: '''OSM''' would result in OSM. For italics you would use two tick marks, so ''OSM'' would result in OSM. The key is to make sure to remove any of those little marks you see showing up in the text and take out any extra spaces. That usually fixes it, but it at times it can take several tries. If you still have trouble just let us know.


Navigation
Volunteer Tools
Other Wikis
Toolbox