Actions

OPOSSEM

Difference between revisions of "Organization"

From OPOSSEM

Line 1: Line 1:
{{SITENAME}} uses the same software the powers [[wikipedia:Main Page|Wikipedia]]. However, several modifications have been made to facilitate the organization and writing of a textbook. Below is an overview of how different parts of the site are organized.  
+
{{SITENAME}} uses the same software the powers [[wikipedia:Main Page|Wikipedia]]. However, several modifications have been made to facilitate the organization and writing of a textbook. Below is an overview of how different parts of the site are organized. It assumes readers are not familiar with MediaWiki. It provides an overview of the site and some recommended practices. It also has links to relevant help files.
 +
 
 
=Namespaces=
 
=Namespaces=
[[Help:Namespaces|Namespaces]] are like folders where different types of [[Help:Pages|pages]] are stored.  
+
[[Help:Namespaces|Namespaces]] are like folders where different types of pages are stored. You could have two different pages with the same name stored in two different namespaces. For instance, you could have a page called About stored in both the OPOSSEM and the Help namespaces. The former would be about OPOSSEM and the latter would be about Help. The URL or the title of a page (unless it is in the Main namespace) will appear as Namespace:PageTitle throughout. Pages in the main namespace appear just as PageTitle.
 +
 
 
==Standard namespaces==
 
==Standard namespaces==
 
All MediaWikis come with a set of [[Help:Namespaces#Standard_namespaces|standard namespaces]]. Each namespace has an associated _Talk namespace for the [[Help:Talk_Pages|Talk_Pages]] that correspond to each page in the namespace. In {{SITENAME}} the namespaces of interest are:
 
All MediaWikis come with a set of [[Help:Namespaces#Standard_namespaces|standard namespaces]]. Each namespace has an associated _Talk namespace for the [[Help:Talk_Pages|Talk_Pages]] that correspond to each page in the namespace. In {{SITENAME}} the namespaces of interest are:
Line 9: Line 11:
 
*[[Help:Templates|Templates]]: Snippets of code used to format references, add default text to pages, etc. Often, templates are protected from editing.
 
*[[Help:Templates|Templates]]: Snippets of code used to format references, add default text to pages, etc. Often, templates are protected from editing.
 
*[[Help:Users|Users]]: User pages, where you can edit your information. You can also create [[Help:Subpages|subpages]] to store snippets of code or your own custom pages that you might want to add to your version of the textbook. Your [[Help:User_page#User_talk_pages|]] can be used for others to contact you or leave a message. You can edit your [[Help:Preferences]] to change how you are contacted if someone posts to your user talk page.  
 
*[[Help:Users|Users]]: User pages, where you can edit your information. You can also create [[Help:Subpages|subpages]] to store snippets of code or your own custom pages that you might want to add to your version of the textbook. Your [[Help:User_page#User_talk_pages|]] can be used for others to contact you or leave a message. You can edit your [[Help:Preferences]] to change how you are contacted if someone posts to your user talk page.  
 +
 
==Custom {{SITENAME}} namespaces==
 
==Custom {{SITENAME}} namespaces==
 
In addition to those above, {{SITENAME}} has two custom namespaces:  
 
In addition to those above, {{SITENAME}} has two custom namespaces:  
 
*Equation: This namespace holds snippets of code that format and display equations on pages. By adding equations here, it ensures that consistent equations and notation are used throughout the text.  
 
*Equation: This namespace holds snippets of code that format and display equations on pages. By adding equations here, it ensures that consistent equations and notation are used throughout the text.  
*Def: This namespace holds glossary terms and definitions. Note: One way to populate these pages would be to import
+
*Def: This namespace holds glossary terms and definitions. Note: One way to populate these pages would be to import the corresponding page from Wikipedia. So during the initial drafting of the textbook, it would be good to add tags for the definitions needed, e.g., <nowiki>{{Def:Variance}}</nowiki>. Then, an admin could look at all the needed definitions and export/import the corresponding Wikipedia page, which our users could then modify/update as appropriate for our community.
 +
 
 +
=Categories=
 +
[[Help:Categories|Categories]] are like 'tags' that can be applied to any page. To tag a page with a category, add <nowiki>[[Category:TagName]]</nowiki>, usually at the bottom of the page. The categories appear at the bottom of the page.
 +
 
 +
The default templates for Equation and Definition pages have Category tags for Equations and Definitions. However, these tags are bracketed by text which categorizes only the Equation and Definition pages, not the pages on which the equation or definition appears. Help pages should also always have added <nowiki>[[Category:Help]]</nowiki>.
 +
 
 +
=Creating new textbook pages=
 +
On the [[Main_Page]], there is a list of textbook topics to be created or edited. Any link in <font color="red">red</font> indicates that the page has yet to be created. When you open a new page, it will have some template text already, including placeholders for headings and examples. This template is defined by [[Template:New_page]].
 +
 
 +
At the bottom of each textbook page, there are headings for discussion questions, problems, and glossary terms. Any special instructions for each of these items appears inside the template as hidden text.
 +
 
 +
=Links=
 +
[[Help:Links]] has detailed information about adding links.
 +
 
 +
Most important is that to add an equation or definition 'in line' (via [[Help:Transclusion|transclusion]], place the name of the equation or definition between {{ }}. To add a link to the equation or definition page, add the name of the equation or definition between [[ ]].
 +
 
 +
=References=
 +
See [[Help:References]]. Also, see [[Template:Quicktemplates]] for snippets of code that will help you add references in-line in your text. Please be sure to add references/links to any datasource you might use to create an example or image.

Revision as of 08:31, 18 June 2011

OPOSSEM uses the same software the powers Wikipedia. However, several modifications have been made to facilitate the organization and writing of a textbook. Below is an overview of how different parts of the site are organized. It assumes readers are not familiar with MediaWiki. It provides an overview of the site and some recommended practices. It also has links to relevant help files.

Namespaces

Namespaces are like folders where different types of pages are stored. You could have two different pages with the same name stored in two different namespaces. For instance, you could have a page called About stored in both the OPOSSEM and the Help namespaces. The former would be about OPOSSEM and the latter would be about Help. The URL or the title of a page (unless it is in the Main namespace) will appear as Namespace:PageTitle throughout. Pages in the main namespace appear just as PageTitle.

Standard namespaces

All MediaWikis come with a set of standard namespaces. Each namespace has an associated _Talk namespace for the Talk_Pages that correspond to each page in the namespace. In OPOSSEM the namespaces of interest are:

  • Main: Topic pages of the textbook are stored here.
  • OPOSSEM: Pages about the OPOSSEM wiki, such as standards and norms, are stored here.
  • Help: Help pages.
  • Templates: Snippets of code used to format references, add default text to pages, etc. Often, templates are protected from editing.
  • Users: User pages, where you can edit your information. You can also create subpages to store snippets of code or your own custom pages that you might want to add to your version of the textbook. Your [[Help:User_page#User_talk_pages|]] can be used for others to contact you or leave a message. You can edit your Help:Preferences to change how you are contacted if someone posts to your user talk page.

Custom OPOSSEM namespaces

In addition to those above, OPOSSEM has two custom namespaces:

  • Equation: This namespace holds snippets of code that format and display equations on pages. By adding equations here, it ensures that consistent equations and notation are used throughout the text.
  • Def: This namespace holds glossary terms and definitions. Note: One way to populate these pages would be to import the corresponding page from Wikipedia. So during the initial drafting of the textbook, it would be good to add tags for the definitions needed, e.g., {{Def:Variance}}. Then, an admin could look at all the needed definitions and export/import the corresponding Wikipedia page, which our users could then modify/update as appropriate for our community.

Categories

Categories are like 'tags' that can be applied to any page. To tag a page with a category, add [[Category:TagName]], usually at the bottom of the page. The categories appear at the bottom of the page.

The default templates for Equation and Definition pages have Category tags for Equations and Definitions. However, these tags are bracketed by text which categorizes only the Equation and Definition pages, not the pages on which the equation or definition appears. Help pages should also always have added [[Category:Help]].

Creating new textbook pages

On the Main_Page, there is a list of textbook topics to be created or edited. Any link in red indicates that the page has yet to be created. When you open a new page, it will have some template text already, including placeholders for headings and examples. This template is defined by Template:New_page.

At the bottom of each textbook page, there are headings for discussion questions, problems, and glossary terms. Any special instructions for each of these items appears inside the template as hidden text.

Links

Help:Links has detailed information about adding links.

Most important is that to add an equation or definition 'in line' (via transclusion, place the name of the equation or definition between {{ }}. To add a link to the equation or definition page, add the name of the equation or definition between [[ ]].

References

See Help:References. Also, see Template:Quicktemplates for snippets of code that will help you add references in-line in your text. Please be sure to add references/links to any datasource you might use to create an example or image.