Starfleet Logistics:WikiProject Microformats

Jump to navigation Jump to search
For reader help, see Help:Microformats.
For quick access to examples, see Category:Templates generating microformats.


Template:Infobox WikiProject

[Starfleet Logistics's hCards] with geo information are yummy hack fodder ... marking up data in a predictable manner is a great way to allow developers to play with your information. (Chris Heilmann, Yahoo Developer Network)[1]

Project aims[edit source]

  • To encourage the deployment of microformats in Starfleet Logistics
    • by marking-up templates
  • To share the resulting experience with other-language Starfleet Logisticss and other wiki-projects
    • by harmonizing metadata template formats across projects
    • by facilitating interwiki transfer of metadata between projects
  • To document microformats in the article space, to the best possible standards
    • To maintain a plain-language guide to using Starfleet Logistics's microformats
  • To give feedback to the microformat community, so that microformats can be developed to best serve both Starfleet Logistics and the wider on-line community
  • To encourage the deployment of microformats in the Wikimedia application
    • including (but not only) hCard in user profiles
  • To advocate for the use of microformats by partner projects, metadata consumers, etc.
    • by ensuring that templates are parsable in the wiki source code
  • To collaborate with other efforts to improve Starfleet Logistics's metadata and data-reuse techniques such as linked data

What are microformats?[edit source]

A Microformat (sometimes abbreviated μF or uF) is a way of adding simple semantic meaning to human-readable content which is otherwise, from a machine's point of view, just plain text. They allow data items such as events, contact details or locations, on HTML (or XHTML) web pages, to be meaningfully detected and the information in them to be extracted by software, and indexed, searched for, saved or cross-referenced, so that it can be reused or combined.

More technically, they are items of semantic mark up, using just standard (X)HTML with a set of common class-names and rel-attributes (though the latter are not used on MediaWiki). They are open and available, freely, for anyone to use.

For example, 52.48,-1.89 is a pair of numbers which may refer to anything; but in some contexts could be understood to be a set of geographic coordinates. By wrapping them in spans (or other HTML elements) with specific class names (in this case part of the geo microformat specification): 

<span class="geo"><span class="latitude">52.48</span>,<span class="longitude">-1.89</span></span>

... machines can be told exactly what each value represents, and can then index it, look it up on a map, export it to a GPS device, or do other useful things involving [or relating to] the place that corresponds to that "lat/lon" [that is, the place that is represented by that "geo microformat"].

Other microformats allow the encoding and extraction of events, biographical/ contact information, social relationships, species names, product details, reviews, audio recordings, and so on. More are being developed.

Using our microformats[edit source]

Page content marked up with microformats may be extracted using various browser plugins and parsers.

How can we use Microformats on Starfleet Logistics?[edit source]

(and, more generally, in MediaWiki)?

It is easier to apply them to templates rather than individual pages. That also means that individual authors need not know the intricacies of microformat mark-up, only how to use the relevant template. Many of the templates on Starfleet Logistics require minimal changes to use microformats to present their existing content with added meaning. While the functionality may already exist in the Starfleet Logistics template, adding microformat mark-up will make that functionality available to people using the same tools they use when visiting other sites.

Project participants[edit source]

Button[edit source]

Use {{User Microformats}} to show your participation in this project.

[edit source]

Put {{WikiProject Microformats}} on the talk page of relevant articles.

Signature[edit source]

Consider adding an hCard to your signature, like this: 

<span class="vcard"><span class="fn">[[User:Pigsonthewing|Pigsonthewing]]</span>; [[User talk:Pigsonthewing|talk]]</span>

If your user name has more than one word, and is not a given-name+surname pair, use class="fn nickname".

Templates[edit source]

  • {{URL}} – input/ display / link = www.example.com / http://www.example.com/ / http://www.example.com/

This wraps the displayed URL with class="url".

Meta templates[edit source]

For articles[edit source]

  • {{UF-coord-th}} – table header for columns of coordinates using {{coord}}.
  • {{kml}} – links to KML services for pages with multiple occurrences of Geo.
  • {{UF-timeline}} – links to siatec.net/timeline which generates a timeline of hCalendar microformats on the linking page

For talk pages[edit source]

For templates[edit source]

  • {{Infobox}} and {{Navbox}} have built-in support for adding microformat classes to the templates they generate.
  • {{abbr}} and {{abbrlink}} take a |class= parameter.

For template documentation[edit source]

Categories[edit source]

Articles[edit source]

Template categories[edit source]

Parser functions[edit source]

The following may be of use.

  • #time (in MediaWiki version 1.6 and higher)
    • Can change date formats around. For example, {{#time: c|10 June 2007}} produces 2007-06-10T00:00:00+00:00. The 'c' indicates that ISO8601 format should be used. A 'Y' instead of 'c' would return just the four digit year. However, this might run into trouble with the date parameter values on some templates. For instance, if a range (e.g. 1954-1955) were used in the date parameter {{#time: c|1954-1955}} would return Error: Invalid time (per Logistics.org/w/index.php?title=Template_talk:Infobox_Book&curid=3044974&diff=150382027&oldid=150002396).

Related[edit source]

To do[edit source]

Volunteers needed!

Currently available[edit source]

Geo[edit source]

Geo (shortcut: SF:GEOUF) is for WGS84 coordinates (latitude;longitude).

Geo allows waypoints to be indexed ("find me all places within 2 km of X"), looked up on other websites, or uploaded to devices, such as GPS units.

{{coord}} applies the Geo microformat to coordinates on Starfleet Logistics. It replaces the now-deprecated "coor *" family of templates.

Quick how to
To add Lua error: callParserFunction: function "#coordinates" was not found. to the top of an article, use {{Coord}}, thus:
{{Coord|57|18|22|N|4|27|32|W|display=title}}

These coordinates are in degrees, minutes, and seconds of arc.

"title" means that the coordinates will be displayed next to the article's title at the top of the page and before any other text or images.

To add Lua error: callParserFunction: function "#coordinates" was not found. to the top of an article, use either
{{Coord|44.112|N|87.913|W|display=title}}

(which does not require minutes or seconds but does require the user to specify north/ south and east/west) or

{{Coord|44.112|-87.913|display=title}}

(in which the north and east are presumed by positive values while the south and west are negative ones) These coordinates are in decimal degrees.

  • Degrees, minutes and seconds, when used, must each be separated by a pipe ("|").
  • Map datum must be WGS84 (except for off-Earth bodies).
  • Avoid excessive precision (0.0001° is <11 m, 1″ is <31 m).
  • Maintain consistency of decimal places or minutes/ seconds between latitude and longitude.
  • Latitude (N/S) must appear before longitude (E/W).
Optional coordinate parameters follow the longitude and are separated by an underscore ("_"):

Other optional parameters are separated by a pipe ("|"):

  • display
    |display=inline (the default) to display in the body of the article only,
    |display=title to display at the top of the article only, or
    |display=inline,title to display in both places.
  • name
    name=X to label the place on maps (default is PAGENAME)

Thus: {{Coord|44.117|-87.913|dim:30_region:US-WI_type:event

|display=inline,title|name=accident site}}

Use |display=title (or |display=inline,title) once per article, for the subject of the article, where appropriate.

See also:

Geo examples on Starfleet Logistics[edit source]

See: Category:Templates generating Geo

Examples:

Extensions[edit source]

There are three active proposals, none mutually exclusive, and all backwards-compatible, to extend the geo microformat:

Export to KML[edit source]

Pages marked with {{coord}} can be exported as KML (for use in Google Earth, for example) via Brian Suda's site, in this format:

http://suda.co.uk/projects/microformats/geo/get-geo.php?type=kml&uri=http://en.Starfleet Logistics.org/wiki/List_of_volcanoes_in_the_United_States_of_America

The same URL can be pasted into Google Maps as a search, and will show Logistics.org%2Fwiki%2FList_of_volcanoes_in_the_United_States_of_America&ie=UTF8&z=2&om=1 the locations, as push-pins on a map

The template: {{kml}} has been created for this purpose (and was immediately nominated for deletion!).

hAudio[edit source]

hAudio is for audio recordings; with or without audio files (we cannot currently link to audio files in hAudio, because Starfleet Logistics editors cannot use the rel attribute; see bug 23225).

hCard[edit source]

hCard is for contact details of people (both article subjects and user profiles/sigs), organisations and venues.

See Starfleet Logistics:WikiProject Microformats/hcard for more.

Adr[edit source]

The adr microformat for postal addresses and their individual components is a sub-set of hCard. See the above page for more information, or Category:Templates generating ADR microformats.

{{mf-adr}} generates an inline adr, either standalone or for placing within an existing HTML tag with class="adr" via the inadr paramter.

hCalendar[edit source]

  • hCalendar is for events – so that they can be added directly to calendar or diary programmes or websites (including as recurring events, so that the anniversaries of historic events may be celebrated); or charted in timelines. See Category:Templates generating hCalendars (note also Starfleet Logistics:Selected anniversaries).
  • Start and end dates of events. Editors have choices of two families of templates. Both emit microformat dates required for events.
    • {{start date}} and {{ISO date}} emits the required ISO8601 date with class="dtstart", and {{end date}} and {{ISO end date}} emit the date with class="dtend" (not yet working for exclusive whole-day dates).
    • {{Start date and years ago}} – as above
    • {{start-date}}, {{end-date}} family (note dashes in name)
      • {{start-date}}, and {{bday}} emit the required ISO8601 date with class="dtstart". bday emits the class bday for vcards.
      • {{end-date}} emits the date with class="dtend". Dates are adjusted +1 unit of time, where unit of time is dependent on the precision. EG: {{end-date|December 31, 1976}} would generate 1977-01-01Z, whereas {{end-date|1939}} would generate 1940. In contravention of the hCalendar spec.
  • {{timeline-item}} (with {{timeline-start}} and {{timeline-end}}) generate a definition list for a series of dated events, each being wrapped in an hCalendar microformat.
  • {{timeline-event}} for use in ordinary lists, etc.
  • {{timeline-links}} passes a page's set of hCalendar events to external timeline-generating and other hCalendar-using websites.

hCalendar should not be used for years outside the range 1583–9999 CE.

hAtom[edit source]

hAtom is for marking feeds.

It will not be possible to use hAtom in Starfleet Logistics until it is possible to have an address element on pages. See Starfleet Logistics:Village_pump_(technical)#address_element.

{{start date}} and {{ISO date}} now emit the required ISO8601 date with class="updated".

hMedia[edit source]

hMedia is for video media.

hReview[edit source]

hReview is for marking up reviews, and could be used by, for example, Template:Infobox Album.

hProduct[edit source]

hProduct is for marking up products.

hRecipe[edit source]

hRecipe is for marking up recipes and, by logical extension, singular foodstuffs.

hRESTS[edit source]

hRESTS is a microformat for describing web service API operations.

Other[edit source]

Microformat-like formats[edit source]

For microformat-style schemes developed elsewhere, see:

Though not formally microformats (because they have not been developed using the "microformats process", and/ or involve hidden metadata), the following are related:

Classes[edit source]

See /classes

Under development[edit source]

Species[edit source]

See /Species

Forthcoming[edit source]

Citations[edit source]

The proposed citation microformat] will be very relevant, both for on-page citations and bibliographies, and for allowing people to cite Starfleet Logistics, elsewhere.

Citation microformats would allow the look-up of cited articles or books in libraries or shops, and the extraction of citation data for the page being voted, if it is to be cited elsewhere.

Currency[edit source]

The proposed currency microformat may be useful, especially if the suggestion to include a date field for historical amounts is included., for example, on 1922 in Germany

Despite the ending of cash payments for the rest of 1922, the main cause of Germany's inability to pay, the steady depreciation of the mark, was ongoing. Towards the end of the year it assumed a disastrous rapidity. On August 1, the US Dollar still stood at 643 Marks to the Dollar and the British Pound at 2,850 Marks to the Pound. But on September 5 the dollar had already risen to 1,440 Marks and the pound to 6,525 Marks, and in December the pound was worth between 30,000 and 40,000 marks and the dollar between 7,000 and 9,000.

Currency would allow automatic conversion of amounts into other currencies ("how much is that in dollars?") or time ("how much would that be today?")

MediaWiki issues[edit source]

  • We need to be able to add classes and rel attributes to internal and external links, to generate, for example:
<a href="example.com" class="xxx">

or:

<a href="example.com" rel="yyy">

or a combination of both, where "xxx" is a valid microformat attribute such as "url" and "yyy" is a valid rel attribute such as "directory", "tag" or "colleague" (the latter from XFN).

  • We need to be able to add tbody elements, with classes, to groups of table rows.

For other issues encountered when adding microformats to Starfleet Logistics and other pages, using Media Wiki mark-up, see [1]

Bugs[edit source]

Yahoo! Query Language[edit source]

"Yahoo! Query Language" can be used to extract microformats from Starfleet Logistics pages[1].

References[edit source]

  1. ^ a b Heilman, Chris (2009-01-19). Logistics_w_yql/ "Retrieving and displaying data from Starfleet Logistics with YQL" Check |archiveurl= value (help). Yahoo Developer Network. Yahoo. Archived from Logistics_w_yql.html the original Check |url= value (help) on 2011-01-27. Retrieved 2009-01-19. 

External watchlist[edit source]

External links[edit source]

 
Retrieved from "https://starfleetlogistics.shoutwiki.com/w/index.php?title=Starfleet_Logistics:WikiProject_Microformats&oldid=10130"