Difference between revisions of "Editing"

From Critiques Of Libertarianism
Jump to: navigation, search
(→‎Quotations)
 
Line 1: Line 1:
 
Editing pages at this site is restricted everywhere except the discussion pages.
 
Editing pages at this site is restricted everywhere except the discussion pages.
  
−
Constructing pages is largely done with transclusions and categories, to simplify and keep uniform the addition and maintenance of pages.
+
This page should explain the editing conventions that keep the site functional and the look-and-feel uniform.
 +
==Indexes==
 +
A major objective is creating indexes by using DPL to display links to and descriptions of pages that are in some category.  This is done with [[Template:List]].  It creates a definition list with the page title as the term to be defined, and the definition information is fetched with the metadata template [[Template:DES]].  The defined term is linked to the wiki page or (if the page has a metadata template [[Template:URL]]) to an external page.  This indexing system deliberately does no transclusion with DPL: all the information extracted comes from the page title and the metadata templates.
  
−
Described, indexable resources are LOCAL wiki pages meant to be viewed directly or EXTERNAL wiki pages that (when transcluded) have external links.  When they are transcluded, they have a link on the top line followed by a description and a [more....] link.  These can be indexed by categories using Template:List Category.
+
Pages indexing categories that resemble Category pages are easily constructed using [[Template:List]] like this:
  
−
LOCAL wiki pages meant to be viewed directly look like this:
+
<code>
 +
<nowiki>
 +
{{List | Some Category Name}}  <!-- if the argument is omitted, PAGENAME is used.
 +
</nowiki>
 +
</code>
  
−
<pre>
+
Here is an example wiki page that could be listed by the above:
−
[[Category:Something]]
+
−
[[Category:Another]]
+
−
{{DES | des = Short description to be transcluded.}}
+
−
Text to be shown when viewed directly.
+
−
</pre>
+
−
 
+
−
EXTERNAL pages are seldom meant to be looked at directly.  When they are transcluded, clicking on their title takes you to the external link outside the wiki.  Clicking on the [more...] at the end takes you to the wiki page itself.  This can be useful if linkrot has occurred, or for reviews of the resource.
+
  
 
<pre>
 
<pre>
−
[[Category:Something]]
+
<nowiki>
−
[[Category:Another]]
+
<noinclude>[[Category:Some Category Name]][[Category:Another]]{{DES | des = Short description to be transcluded.}}</noinclude>
 
{{URL | url = the URL of the resource}}
 
{{URL | url = the URL of the resource}}
−
{{DES | des = Short description to be transcluded.}}
+
{{Other URL | url = another URL of the resource}} <!-- never a reason to throw away such information -->
−
Text to be shown when viewed directly (by clicking the [more...])
+
{{Old URL | url = a formerly working URL of the resource}} <!-- never a reason to throw away such information -->
 +
Text on the page.
 +
</nowiki>
 
</pre>
 
</pre>
  
−
Pages indexing categories that resemble Category pages are easily constructed using Template:List Category like this:
+
The above example is in the two categories explicitly listed, and [[Category:Description]] from the transcluded [[Template:DES]].  The presence of the [[Template:URL]] makes this [[Template:List]] display this title with an external link and a [more...] link to the wiki page.  If the [[Template:URL]] is not there, the title is linked to the wiki page only.  The <nowiki><noinclude></nowiki> is not necessary unless this page is going to be transcluded elsewhere (since [[Template:List]] does not transclude.)
  
−
<pre>
+
The title linked to the URL can also be displayed for an individual page with [[Template:Link]].
−
{{List Category | cat = any category name}}
+
 
−
</pre>
+
<code>
 +
<nowiki>
 +
You really might want to read: {{Link | Some Page Name}}.
 +
</nowiki>
 +
</code>
 +
 
 +
==Quotations==
 +
A major objective is to make lists of quotations from authors, books and other sources and categorize them by author, index (subject), and book (or other publication.)  Quotations are available in lists (with [[Template:Quotes]] or singly (with [[Template:QuoteText]] and [[Template:QuoteCite]].)
 +
 
 +
Each quotation should be hidden as a subpage of an author, book or other source.  The subpage would not normally be viewed by readers.  Instead, quotations are normally read either as collections in a category (with [[Template:Quotes]]) or inserted in text (with other templates.)  [[Template:Quote]] automatically places quotes in two categories: [[:Category:Quotations]] and a category for the base page.  Other categories should be manually inserted.  If there is a choice between the subpage of a source versus the subpage of a person, choose the former.  As many subject categories as wanted can be added.
 +
 
 +
Quotations have a text and a citation which are set with a metadata template.  DPL is used to extract this information.  Quotation pages should never be transcluded because that would also transclude the [[Template:Quote]] and its categorizations.
 +
 
 +
To add a quote, use [[Template:Quote]]:
 +
 
 +
<code>
 +
<nowiki>
 +
{{Quote | text = something somebody said | cite = whoever said it}}.
 +
</nowiki>
 +
</code>
 +
 
 +
When adding a quote, it is good to:
 +
* add categories for the author(s), publication, and desired indexes
 +
* add links for the above in the citation
 +
* add links in the text as needed
 +
* add <nowiki>{{Quotes}}</nowiki> to the pages for the author(s), publication, and desired indexes
 +
* add redirects for the categories for the author(s), publication, and desired indexes to the pages
 +
 
 +
Use [[Template:Quotes]] to display quotes in a category:
 +
 
 +
<code>
 +
<nowiki>
 +
{{Quotes | some category}}. <!-- argument is optional, if omitted, PAGENAME is used for the category -->
 +
</nowiki>
 +
</code>
 +
 
 +
To insert a quote on a page, use [[Template:QuoteText]] for the text and [[Template:QuoteCite]] for the citation.  While this isn't the most convenient way, it is the most flexible, since you can put it in quotes, use <nowiki><blockquote></nowiki>, put the citation in a reference, etc.
 +
 
 +
For example:
 +
 
 +
<code>
 +
<nowiki>
 +
Somebody said "{{QuoteText | some quotation}}"<ref>{{QuoteCite | some quotation}}</ref> somewhere.
 +
</nowiki>
 +
</code>
  
−
So all indexing is done by placing categories in a wiki page. The indexes are dynamically built with DPL transclusions.  You can mix LOCAL and EXTERNAL resources in the indexes.
+
==Books==
 +
Another major objective is to list books in a form that (a) permits transclusion as a citation (b) provides descriptions of the content (c) provides links to online sources such as libraries, bookstores, online copies, etc. (d) has lists of useful quotes from the book (e) allows the books to be indexed with [[Template:List Category]].
  
−
It's easiest to create a new resource by copying from another.
+
It's easiest to create a new page by copying from another, similar one.

Latest revision as of 12:56, 8 November 2010

Retrieved from "http://critiques.us/index.php?title=Editing&oldid=1529"