Microformats.org Wiki 2.0

(Difference between revisions)

Jump to: navigation, search
Current revision (11:09, 22 September 2013) (view source)
m (Reverted edits by I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST ([[User talk:I MADE THOUSANDS OF ACCOUNTS IN MICROF)
 
Line 1: Line 1:
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
<entry-title>Microformats.org Wiki 2.0</entry-title>
 +
<p class="entry-summary">Microformats.org has been served by a near-default MediaWiki theme since it first went live in 2005. Over the years the kind of content published on the wiki has been established, and the editing practices of our community better understood. The ‘Wiki 2.0’ project is a medium-sized undertaking to update our wiki software to better suit the communities needs, and take the opportunity to add some visual sparkle too.</p>
 +
__TOC__
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
==Summary of Changes==
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
* MediaWiki has been updated from version 1.4 to version 1.13.2.
 +
* The visual styling of the wiki has been upgraded to a completely custom skin, based on Dan Cederholm's original microformats.org design.
 +
* The search feature is now located at the top-right of the page, because having it buried further down was silly.
 +
* The header now links to other vital parts of the microformats site — the blog and the mailing list archives.
 +
* Some new extensions have been added to the MediaWiki install
 +
** HTML phrase elements are now fully supported
 +
** Code syntax highlighting has been added
 +
** Page titles can now be overwritten in mark-up (e.g. ‘hcard’ can become ‘hCard’, or more ambitious transformations)
 +
* ‘Talk’ pages have been <strong>completely</strong> disabled, rather than just ‘hidden’.
 +
* All wiki pages are marked up with [[hAtom]] and [[hCalendar]]
 +
* We will now be using MediaWiki's categories feature to better organize our content.
 +
** Pages placed into the Specifications category gets special ‘spec-like’ styling (see [[hCard]]).
 +
** Pages places into the Draft Specifications category get different special ‘spec-like’ styling (see [[hResume]])
 +
** Pages placed into either specification category will generate links to their respective -issues pages
 +
* TOC — table of contents — is now properly styled in the theme. There is nolonger a need to use inline styles to align the TOC to the right
 +
* There is now styling support for both inline issues tracking and discussions within list nesting. Previously it was hard to identify discussion documentation from proposed content, and hard to follow threads. Mark-up is now supported to style these more apporpriately
 +
* Your username now has a [http://gravatar.com Gravatar] displayed alongside, as in blog comments.
 +
* When editing, the ‘Save’ and ‘Preview’ buttons have been reversed to try and encourage people to preview more before posting
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
==How to Use Wiki 2.0==
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
The following tries to explain how best to use the new features in Wiki 2.0.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
===Page Titles===
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
Between version 1.4 and 1.13 MediaWiki fixed a bug whereby headings marked up with HTML elements were excluded from the generated Table of Contents on pages. We have since used <code>H1</code> elements to override the headings of pages whilst not offsetting the TOC numbering into 1.1, 1.2, 1.3, etc. Since that bug is fixed, this hack has been replaced with a more robust mechanism.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
<em>Rather than use <code>H1</code> elements to title your pages, instead use the new <code>entry-title</code> element</em>. This is parsed by a MediaWiki extension and overrides the entry title as displayed on the page, whilst excluding it from the TOC. It is so named, because it corresponds to the entry-title element in the underlying hAtom that each entry is now marked up with.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
===Writing Specifications===
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
The new wiki supports special display of specification documents, different from regular pages. The pages are styled more plainly and content spans the full width of the page, akin to documentation from the W3C, WHATWG and other bodies. The sidebar is pushed down into an expanded footer, so all functionality remains.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
To enable these views, you must add your page to a particular category.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
* Specifications should be added to the ‘Specifications’ category, by including <nowiki>[[Category:Specifications]]</nowiki> at the base of the document.
 +
* Draft Specifications should be added to the ‘Draft Specifications’ category, by including <nowiki>[[Category:Draft Specifications]]</nowiki> at the base of the document. You '''must''' also include the <nowiki>{{DraftSpecification}}</nowiki> template at the head of your document, to provide textual differentiation of the draft.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
Please note that issues pages, brainstorming pages, straw-men and anything else not explicitly a Draft Specification or Specification document should not be added to these categories and should continue to be presented as regular wiki pages.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
Categories should be declared at the base of articles, please.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
===Discussions and Issues===
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
Within documents discussions are often represented through nested lists. They are hard to follow, and hard to differentiate from the actual content of the document. You can now mark them up and have them presented more appropriately, and hopefully more clearly.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
* For <em>discussions</em>: Surround the thread with <code>&lt;div class="discussion">&lt;/div></code>.
 +
* For raising <em>issues</em>: Surround the thread with <code>&lt;div class="discussion issues">&lt;/div></code>.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
The following are examples to show the rendering:
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
<div class="discussion">
 +
* I'm not happy with the phrasing of the above. --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
 +
** I disagree, I think it's fine! --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
 +
</div>
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
<div class="discussion issues">
 +
* '''New wiki does not support declarative creation of animated GIFs on profile pages'''. This is a big deal for me! --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
 +
** No. Just… no! --[[User:BenWard|BenWard]] 09:50, 17 November 2008 (UTC)
 +
</div>
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
'''Always''' sign your contributions to discussions using the string <nowiki>--~~~~</nowiki> at the end of your text.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
===Code Highlighting===
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
We've installed a [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi Syntax Highlighting extension]. This allows you to have nicer highlighting of many languages used in examples and code snippets on the wiki.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
* To use syntax highlighted source blocks, use the new <code>&lt;source></code> element. E.g.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
<pre><nowiki>
 +
  <source lang=html4strict>
 +
  <div class="vcard">
 +
    <a class="fn org" href="http://microformats.org">Microformats.org</a>
 +
  </div>
 +
  </source>
 +
</nowiki></pre>
 +
 +
Produces:
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
  <source lang=html4strict>
 +
  <div class="vcard">
 +
    <a class="fn org" href="http://microformats.org">Microformats.org</a>
 +
  </div>
 +
  </source>
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
Note that the language name for HTML is <code>html4strict</code>, not just ‘HTML’. You can find the full list of supported languages on the Syntax Highlighter extension page: http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
==Credits==
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
The Wiki 2.0 project was implemented by [[User:BenWard]]. The visual style is derived from the original microformats.org theme by [http://simplebits.com Dan Cederholm]. The wiki also uses the wonderfully useful [http://famfamfam.com/lab/icons/silk/ Fam Fam Fam Silk icons] by Mark James.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
==Issues==
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
Please report, bugs issues and requests on the [[wiki-2-issues]] page.
-
I MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LISTI MADE THOUSANDS OF ACCOUNTS IN MICROFORMATS WIKI GO TO CHECK OUT THE USER LIST
+
== related ==
 +
* [[mediawiki-customization]]
 +
 
 +
[[Category:Microformats.org]]
 +
[[Category:Wiki]]

Current revision

Microformats.org has been served by a near-default MediaWiki theme since it first went live in 2005. Over the years the kind of content published on the wiki has been established, and the editing practices of our community better understood. The ‘Wiki 2.0’ project is a medium-sized undertaking to update our wiki software to better suit the communities needs, and take the opportunity to add some visual sparkle too.

Contents


Summary of Changes

How to Use Wiki 2.0

The following tries to explain how best to use the new features in Wiki 2.0.

Page Titles

Between version 1.4 and 1.13 MediaWiki fixed a bug whereby headings marked up with HTML elements were excluded from the generated Table of Contents on pages. We have since used H1 elements to override the headings of pages whilst not offsetting the TOC numbering into 1.1, 1.2, 1.3, etc. Since that bug is fixed, this hack has been replaced with a more robust mechanism.

Rather than use H1 elements to title your pages, instead use the new entry-title element. This is parsed by a MediaWiki extension and overrides the entry title as displayed on the page, whilst excluding it from the TOC. It is so named, because it corresponds to the entry-title element in the underlying hAtom that each entry is now marked up with.

Writing Specifications

The new wiki supports special display of specification documents, different from regular pages. The pages are styled more plainly and content spans the full width of the page, akin to documentation from the W3C, WHATWG and other bodies. The sidebar is pushed down into an expanded footer, so all functionality remains.

To enable these views, you must add your page to a particular category.

Please note that issues pages, brainstorming pages, straw-men and anything else not explicitly a Draft Specification or Specification document should not be added to these categories and should continue to be presented as regular wiki pages.

Categories should be declared at the base of articles, please.

Discussions and Issues

Within documents discussions are often represented through nested lists. They are hard to follow, and hard to differentiate from the actual content of the document. You can now mark them up and have them presented more appropriately, and hopefully more clearly.

The following are examples to show the rendering:

  • I'm not happy with the phrasing of the above. --BenWard 09:50, 17 November 2008 (UTC)
    • I disagree, I think it's fine! --BenWard 09:50, 17 November 2008 (UTC)
  • New wiki does not support declarative creation of animated GIFs on profile pages. This is a big deal for me! --BenWard 09:50, 17 November 2008 (UTC)
    • No. Just… no! --BenWard 09:50, 17 November 2008 (UTC)

Always sign your contributions to discussions using the string --~~~~ at the end of your text.

Code Highlighting

We've installed a Syntax Highlighting extension. This allows you to have nicer highlighting of many languages used in examples and code snippets on the wiki.

  <source lang=html4strict>
  <div class="vcard">
    <a class="fn org" href="http://microformats.org">Microformats.org</a>
  </div>
  </source>

Produces:

<div class="vcard">
    <a class="fn org" href="http://microformats.org">Microformats.org</a>
  </div>

Note that the language name for HTML is html4strict, not just ‘HTML’. You can find the full list of supported languages on the Syntax Highlighter extension page: http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages

Credits

The Wiki 2.0 project was implemented by User:BenWard. The visual style is derived from the original microformats.org theme by Dan Cederholm. The wiki also uses the wonderfully useful Fam Fam Fam Silk icons by Mark James.

Issues

Please report, bugs issues and requests on the wiki-2-issues page.

related

Categories

Microformats.org Wiki 2.0 was last modified: Sunday, September 22nd, 2013

Views