Wiki Instructions - Revision history

Daniel Robbins: /* Headings, Table of Contents, Paragraphs */

2015-07-28T20:20:22Z

‎Headings, Table of Contents, Paragraphs

Daniel Robbins: /* Defining References */

2015-07-27T19:01:34Z

‎Defining References

Daniel Robbins at 18:59, 27 July 2015

2015-07-27T18:59:58Z

Daniel Robbins at 18:58, 27 July 2015

2015-07-27T18:58:30Z

Daniel Robbins at 18:54, 27 July 2015

2015-07-27T18:54:03Z

Daniel Robbins: /* References */

2015-07-27T18:48:32Z

‎References

Daniel Robbins: /* Paragraphs */

2015-07-27T18:42:06Z

‎Paragraphs

Daniel Robbins: /* Acronyms */

2015-07-27T18:41:10Z

‎Acronyms

Daniel Robbins: /* Pre-TOC Sections */

2015-07-27T18:32:14Z

‎Pre-TOC Sections

Daniel Robbins: /* Paragraphs */

2015-07-27T18:29:47Z

‎Paragraphs

← Older revision		Revision as of 20:20, 28 July 2015
Line 8:		Line 8:

	MediaWiki uses ''wikitext'' to define pages, which is a special text format that allows one to define paragraphs, headings, references, etc. Headings can be created using the following wikitext, which should appear on its own line, with no preceding spaces:		MediaWiki uses ''wikitext'' to define pages, which is a special text format that allows one to define paragraphs, headings, references, etc. Headings can be created using the following wikitext, which should appear on its own line, with no preceding spaces:
−

	Top-level heading:		Top-level heading:

@@ Line 115: / Line 115: @@
 </pre>
-Since this is a somewhat complex set of nested template calls, let's take a look at how these templates work together. The outermost template is an <code><nowiki>{{EndSection}}</nowiki></code> template, which creates a section at the end of the document that is not listed in the TOC. The body of this template is one or more <code><nowiki>{{Reference}}</nowiki></code> templates, which are used to store the reference data, but do not display anything on the page. Then, following the list of references, the <nowiki>{{ReferenceList}}</nowiki></code> template appears, which will display a list of references in order.
+Since this is a somewhat complex set of nested template calls, let's take a look at how these templates work together. The outermost template is an <code><nowiki>{{EndSection}}</nowiki></code> template, which creates a section at the end of the document that is not listed in the TOC. The body of this template is one or more <code><nowiki>{{Reference}}</nowiki></code> templates, which are used to store the reference data, but do not display anything on the page. Then, following the list of references, the <code><nowiki>{{ReferenceList}}</nowiki></code> template appears, which will display a list of references in order.
 Individual references use the following format, which can be viewed by viewing the [[Template:Reference]] page:

@@ Line 3: / Line 3: @@
 == Document Structure ==
-Each chapter of the SWEBOK should be stored on its own wiki page, entitled "Chapter X: Chapter Title Here". This page can be created by replacing all spaces with underscores in this suggested page title, and entering the URL "http://swebokwiki.org/Chapter_X:_Chapter_Title_Here". When the page loads, click on "Create" to create the new page. Note that page names are case-sensitive.
+Each chapter of the SWEBOK should be stored on its own wiki page, entitled "Chapter X: Chapter Title Here". These page links are listed at the end of this page.
 == Headings, Table of Contents, Paragraphs ==

← Older revision		Revision as of 18:58, 27 July 2015
Line 1:		Line 1:
−	This page contains instructions for how to utilize the wiki for the SWEBOK. In order to simplify maintenance, every attempt has been made to leverage standard wiki features when possible.	+	This page contains instructions for how to utilize the wiki for the SWEBOK. In order to simplify maintenance, every attempt has been made to leverage standard wiki features when possible, and customize them as needed to reflect the general document structure and formatting of the printed SWEBOK.

	== Document Structure ==		== Document Structure ==

← Older revision		Revision as of 18:54, 27 July 2015
Line 153:		Line 153:

	Simply separate each <code><nowiki>{{referenceLink}}</nowiki></code> template call by a space.		Simply separate each <code><nowiki>{{referenceLink}}</nowiki></code> template call by a space.
		+
		+	== Chapter Structure ==
		+
		+	For the purposes of translating the SWEBOK to wikitext, it is best to focus on the content sections for now. Using the guidelines in this page, and the [[Test]] chapter page as an example, the converted wikitext for each chapter can be stored on the following pages:
		+
		+	* [[Chapter 1: Software Requirements]]
		+	* [[Chapter 2: Software Design]]
		+	* [[Chapter 3: Software Construction]]
		+	* [[Chapter 4: Software Testing]]
		+	* [[Chapter 5: Software Maintenance]]
		+	* [[Chapter 6: Software Configuration Management]]
		+	* [[Chapter 7: Software Engineering Management]]
		+	* [[Chapter 8: Software Engineering Process]]
		+	* [[Chapter 9: Software Engineering Models]]
		+	* [[Chapter 10: Software Quality]]
		+	* [[Chapter 11: Software Engineering Professional Practice]]
		+	* [[Chapter 12: Software Engineering Economics]]
		+	* [[Chapter 13: Computing Foundations]]
		+	* [[Chapter 14: Mathematical Foundations]]
		+	* [[Chapter 15: Engineering Foundations]]

@@ Line 99: / Line 99: @@
 As you can see, the <code><nowiki>{{Acronyms}}</nowiki></code> template serves as a container for the other templates. Acronym definition lists should appear in the wikitext where they should normally appear in the flow of the document, typically at the very beginning of each chapter.
-== References ==
+== Defining References ==
 References are defined in an <code><nowiki>{{EndSection}}</nowiki></code> template at the end of each chapter page, which has a basic structure as follows:
@@ Line 135: / Line 135: @@
 Above, the '''number''' parameter is used to specify the number associated with the reference in this chapter. Most other parameters should be self-explanatory. The '''issue''' parameter is used to specify an issue number of a journal or magazine, while the '''part''' parameter is used to specify a list of pages or sections in a publication. The '''link''' parameter is used to specify a hyperlink in <code><nowiki>http://</nowiki></code> format when referencing an online resource.

@@ Line 28: / Line 28: @@
 Paragraphs can be stored in wikitext as successive lines of text that do not begin with any spaces. MediaWiki will combine these lines and display them as a single paragraph. To create a new paragraph, insert two blank lines within the wikitext. Sentences can span multiple lines. When converting paragraphs from the existing SWEBOK PDF, care must be taken to remove hyphenated words and replace them with non-hyphenated versions. It may be easier to use the source Microsoft Word document to copy and paste paragraphs, with hyphenation turned off.
-All paragraphs will be indented automatically. In the SWEBOK, initial paragraphs in each section are not indented. The <code><nowiki>{{NoIndent}}</nowiki></code> template can be used to wrap the first paragraph in each section so that it is not indented. It is used as follows:
+{{NoIndent|All paragraphs will be indented automatically. In the SWEBOK, initial paragraphs in each section are not indented. The <code><nowiki>{{NoIndent}}</nowiki></code> template can be used to wrap the first paragraph in each section so that it is not indented. You can view the wikitext of this paragraph or the following example to see how it is used:}}
 <pre>

← Older revision		Revision as of 18:41, 27 July 2015
Line 98:		Line 98:

	As you can see, the <code><nowiki>{{Acronyms}}</nowiki></code> template serves as a container for the other templates. Acronym definition lists should appear in the wikitext where they should normally appear in the flow of the document, typically at the very beginning of each chapter.		As you can see, the <code><nowiki>{{Acronyms}}</nowiki></code> template serves as a container for the other templates. Acronym definition lists should appear in the wikitext where they should normally appear in the flow of the document, typically at the very beginning of each chapter.
		+
		+	== References ==
		+
		+	References are defined in an <code><nowiki>{{EndSection}}</nowiki></code> template at the end of each chapter page, which has a basic structure as follows:
		+
		+	<pre>
		+	{{EndSection\|title=References\|body=
		+	{{reference
		+	\|number=1
		+	...(more text here)...
		+	}}{{reference
		+	\|number=2
		+	...(more text here)...
		+	}}{{ReferenceList}}
		+	}}
		+	</pre>
		+
		+	Since this is a somewhat complex set of nested template calls, let's take a look at how these templates work together. The outermost template is an <code><nowiki>{{EndSection}}</nowiki></code> template, which creates a section at the end of the document that is not listed in the TOC. The body of this template is one or more <code><nowiki>{{Reference}}</nowiki></code> templates, which are used to store the reference data, but do not display anything on the page. Then, following the list of references, the <nowiki>{{ReferenceList}}</nowiki></code> template appears, which will display a list of references in order.
		+
		+	Individual references use the following format, which can be viewed by viewing the [[Template:Reference]] page:
		+
		+	<pre>
		+	{{reference
		+	\|number=
		+	\|author=
		+	\|article=
		+	\|publication=
		+	\|edition=
		+	\|publisher=
		+	\|issue=
		+	\|date=
		+	\|part=
		+	\|link=
		+	}}
		+	</pre>
		+
		+	Above, the '''number''' parameter is used to specify the number associated with the reference in this chapter. Most other parameters should be self-explanatory. The '''issue''' parameter is used to specify an issue number of a journal or magazine, while the '''part''' parameter is used to specify a list of pages or sections in a publication. The '''link''' parameter is used to specify a hyperlink in <code><nowiki>http://</nowiki></code> format when referencing an online resource.

← Older revision		Revision as of 18:32, 27 July 2015
Line 79:		Line 79:

	----		----
		+
		+	== Post-TOC Sections ==
		+
		+	All chapters have post-TOC sections that are not numbered. Similarly to the <code>IntroSection</code> template, there is a <code>EndSection</code> template which works identically and can be used to create sections of text (like '''References''' and '''Further Readings''') that appear as unindexed sections after the main TOC.
		+
		+	To see these sections in use, see the [[Test]] chapter wiki page, and click "Edit" or "View Source" to see the corresponding wikitext.

	== Acronyms ==		== Acronyms ==