Big task list

From The_Open_Source_Way

(Difference between revisions)
Jump to: navigation, search
(adding more instructions on how to break-out individual section pages from the parent chapter page)
Line 15: Line 15:
** Take a look at fedoraproject.org, e.g. https://fedoraproject.org/wiki/Help:Editing
** Take a look at fedoraproject.org, e.g. https://fedoraproject.org/wiki/Help:Editing
*** Make sure to attribute in the "Summary:" field with the URL back to the source page.
*** Make sure to attribute in the "Summary:" field with the URL back to the source page.
 +
 +
=== Topic-specific pages ===
 +
 +
MediaWiki works best when each node of information is a unique page.  These can be transcluded to make single source pages for a group of information.  In this book, each chapter has multiple sections and sub-sections.  Each section and probably each next-level sub-section need to be converted to individual pages.
 +
 +
# Take a chapter.
 +
# Create a new page for each <nowiki>== Section 2 ==</nowiki> named the same as the section name.
 +
#* The new page should ''not'' include the page title as a separate section header; remove that header and let the page stand as the "header 1" for that page.
 +
# Make certain that each new page is in relevant categories:
 +
#* [[:Category:The Open Source Way book]]
 +
#* [[:Category:Name of chapter it is included in]]
 +
#* [[:Category:Book chapter sections]]
 +
# In the chapter page, use transclusion to pull in the sub-sections.
 +
#* Include appropriate categories for the chapter
 +
#** [[:Category:The Open Source Way book]]
 +
#** [[:Category:Name of chapter]]
 +
# Sections may be transcluded in to other sections, and then aggregated in to chapters, but the section markup needs to be manually organized.  For example:
 +
## [[Chapter 1]] pulls in (transcludes) [[Section A]]
 +
## [[Section A]] transcludes a number of subsections, such as [[Section Q]]
 +
## Make sure that the <nowiki>== Sections ==</nowiki> are properly set to give the desire nesting.  You can tell when things are off by checking the table of contents on the page doing the top-level transclusion.
== DocBook XML ==
== DocBook XML ==

Revision as of 22:51, 26 February 2010

Updated 2010-02-16

This is one, big task list.

Contents

Content

Wiki

Topic-specific pages

MediaWiki works best when each node of information is a unique page. These can be transcluded to make single source pages for a group of information. In this book, each chapter has multiple sections and sub-sections. Each section and probably each next-level sub-section need to be converted to individual pages.

  1. Take a chapter.
  2. Create a new page for each == Section 2 == named the same as the section name.
    • The new page should not include the page title as a separate section header; remove that header and let the page stand as the "header 1" for that page.
  3. Make certain that each new page is in relevant categories:
  4. In the chapter page, use transclusion to pull in the sub-sections.
  5. Sections may be transcluded in to other sections, and then aggregated in to chapters, but the section markup needs to be manually organized. For example:
    1. Chapter 1 pulls in (transcludes) Section A
    2. Section A transcludes a number of subsections, such as Section Q
    3. Make sure that the == Sections == are properly set to give the desire nesting. You can tell when things are off by checking the table of contents on the page doing the top-level transclusion.

DocBook XML


Sysadmin

Retrieved from "https://www.theopensourceway.org/wiki/Big_task_list"
Personal tools