Difference between revisions of "downloads-examples"

From Microformats Wiki
downloads-examples
Jump to navigation Jump to search
(adding wordpress.org plugins)
(fleshing out iusethis, mozilla addons and tweaking the wordpress listing)
Line 10: Line 10:
 
==Examples==
 
==Examples==
  
===Mozilla Firefox===
+
===Mozilla Addons===
  
 
*Extension (single instance) e.g. [https://addons.mozilla.org/en-US/firefox/addon/722 NoScript]
 
*Extension (single instance) e.g. [https://addons.mozilla.org/en-US/firefox/addon/722 NoScript]
 
**Extension version history (multiple instances of one app) e.g. [https://addons.mozilla.org/en-US/firefox/addons/versions/722 NoScript history]
 
**Extension version history (multiple instances of one app) e.g. [https://addons.mozilla.org/en-US/firefox/addons/versions/722 NoScript history]
 +
 +
====Attributes====
 +
 +
<dl>
 +
<dt>Extension name</dt><dd>The name of the extension.</dd>
 +
<dt>Extension version</dt><dd>A numerical version number.</dd>
 +
<dt>Extension author</dt><dd>Who created the extension with a link to their Addons profile.</dd>
 +
<dt>Works with</dt><dd>Compatibility listing of browser(s) the plugin should work with.</dd>
 +
<dt>Preview/Logo</dt><dd>An icon or screenshot(s) for the plugin.</dd>
 +
<dt>Install now</dt><dd>Link to XPI file for installation (Mozilla browsers only).</dd>
 +
<dt>Developer comments</dt><dd>Description of the plugin or installation instructions.</dd>
 +
<dt>Version History</dt><dd>List of plugin releases with version numbers and release dates (with a link to complete revision history).</dd>
 +
<dt>Reviews</dt><dd>A list of user-submitted reviews.</dd>
 +
<dt>Discussions</dt><dd>A list of user-created discussions.</dd>
 +
</dl>
  
 
----
 
----
Line 20: Line 35:
  
 
* Download page, e.g. http://osx.iusethis.com/app/peek-a-boo
 
* Download page, e.g. http://osx.iusethis.com/app/peek-a-boo
** No version history or release notes
+
** Version history or release notes
** Does not list older downloads
+
** Lists older downloads when you click on the current version number.
* Appcast, e.g. http://osx.iusethis.com/appcast/igtd
+
* [http://blog.iusethis.com/ Supports auto-updating its database with appcasts], also generates appcasts, e.g. http://osx.iusethis.com/appcast/igtd
 
** Every download page has a related appcast RSS feed (with autodiscovery)
 
** Every download page has a related appcast RSS feed (with autodiscovery)
  
Line 61: Line 76:
 
* <code>sparkle:appLicense</code> is something iusethis-specific, something the iusethis team seems to have made up. No idea why they are using the sparkle namespace here...
 
* <code>sparkle:appLicense</code> is something iusethis-specific, something the iusethis team seems to have made up. No idea why they are using the sparkle namespace here...
 
* <code>sparkle:shortVersionString</code> seems to be used instead of <code>sparkle:version</code>, and I'm not sure why.
 
* <code>sparkle:shortVersionString</code> seems to be used instead of <code>sparkle:version</code>, and I'm not sure why.
 +
 +
====Attributes====
 +
 +
<dl>
 +
<dt>Application Name</dt><dd>Name of the application</dd>
 +
<dt>Homepage URL</dt><dd>Link to homepage</dd>
 +
<dt>Download URL</dt><dd>Link to file download</dd>
 +
<dt>Appcast (Optional)</dt><dd>Link to Sparkle-RSS feed.</dd>
 +
<dt>Developer (optional)</dt><dd>Name of the developer.</dd>
 +
<dt>License</dt><dd>Dropdown list of these options: Freeware, Shareware, GPL, LGPL, BSD License, Charityware, Other Open Source, Commercial with demo</dd>
 +
<dt>Keywords</dt><dd>Comma-separated list of keywords.</dd>
 +
<dt>Description</dt><dd>Description of the application.</dd>
 +
<dt>Universal binary</dt><dd>True/False for Intel/PPC compatibility.</dd>
 +
<dt>Icon</dt><dd>32x32 pixel application icon.</dd>
 +
<dt>Screenshot</dt><dd>Image of the application.</dd>
 +
</dl>
  
 
----
 
----
Line 95: Line 126:
 
===WordPress Plugins===
 
===WordPress Plugins===
  
WordPress generates plugin pages from a http://wordpress.org/extend/plugins/about/readme.txt readme.txt] file included with the plugin. It has its own parser and format standards.
+
WordPress generates plugin pages from a [http://wordpress.org/extend/plugins/about/readme.txt readme.txt] file included with the plugin. It has its own [http://wordpress.org/extend/plugins/about/validator/ validator] and format standards.
  
'''Attributes:'''
+
====Attributes====
  
 
<dl>
 
<dl>
 +
<dt>Plugin name</dt><dd>The name of the plugin.</dd>
 
<dt>Authors</dt><dd>Author field from the plugin file and Contributors field from the readme file.</dd>
 
<dt>Authors</dt><dd>Author field from the plugin file and Contributors field from the readme file.</dd>
 
<dt>Version</dt><dd>Version field from the plugin file.</dd>
 
<dt>Version</dt><dd>Version field from the plugin file.</dd>
Line 105: Line 137:
 
<dt>Last updated time</dt><dd>Time of last check in to the appropriate directory (trunk/ or the stable tag directory) after a version number change.</dd>
 
<dt>Last updated time</dt><dd>Time of last check in to the appropriate directory (trunk/ or the stable tag directory) after a version number change.</dd>
 
<dt>Creation time</dt><dd>Time of first check in.</dd>
 
<dt>Creation time</dt><dd>Time of first check in.</dd>
 +
<dt>Rating</dt><dd>A rating up to five stars.</dd>
 +
<dt>Download link</dt><dd>The URL to download the plugin zip file.</dd>
 +
<dt>Description</dt><dd>The description of the plugin.</dd>
 
</dl>
 
</dl>
  

Revision as of 03:29, 18 November 2007

Downloads examples

Contributors

Examples

Mozilla Addons

  • Extension (single instance) e.g. NoScript

Attributes

Extension name
The name of the extension.
Extension version
A numerical version number.
Extension author
Who created the extension with a link to their Addons profile.
Works with
Compatibility listing of browser(s) the plugin should work with.
Preview/Logo
An icon or screenshot(s) for the plugin.
Install now
Link to XPI file for installation (Mozilla browsers only).
Developer comments
Description of the plugin or installation instructions.
Version History
List of plugin releases with version numbers and release dates (with a link to complete revision history).
Reviews
A list of user-submitted reviews.
Discussions
A list of user-created discussions.

iusethis

iusethis provides RSS appcasts with Sparkle extensions. For example:

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:blogChannel="http://backend.userland.com/blogChannelModule"
     xmlns:iusethis="http://osx.iusethis.com/ns/rss"
     xmlns:content="http://purl.org/rss/1.0/modules/content/"
     xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle"
     version="2.0">
  <channel>
    <title>Appcast for iGTD</title>
    <link>http://osx.iusethis.com/app/igtd</link>
    <description>version history with a sparkle via iusethis.com</description>
    <language>en-us</language>
    <iusethis:universal>1</iusethis:universal>
    <iusethis:homepage>http://bargiel.home.pl/iGTD/</iusethis:homepage>
    <iusethis:developer>bartek:bargiel</iusethis:developer>
    <iusethis:usecount>517</iusethis:usecount>
    <iusethis:tags>GTD productivity get things done</iusethis:tags>
    <sparkle:appLicense>Freeware</sparkle:appLicense>
    <item>
      <title>iGTD 1.4.5.5</title>
      <link>http://osx.iusethis.com/app/versions/7961#ver_35136</link>
      <description><![CDATA[<p>... appcast description goes here ...</p>]]></description>
      <guid isPermaLink="false">35136</guid>
      <pubDate>Thu, 09 Aug 2007 09:31:55 -0000</pubDate>
      <enclosure url="http://bargiel.home.pl/downloads/iGTD.dmg" type="application/octet-stream"/>
      <sparkle:shortVersionString>1.4.5.5</sparkle:shortVersionString>
    </item>
    <!-- ... more appcast items go here .. -->
  </channel>
</rss>

Some notes about the RSS appcast:

  • sparkle:appLicense is something iusethis-specific, something the iusethis team seems to have made up. No idea why they are using the sparkle namespace here...
  • sparkle:shortVersionString seems to be used instead of sparkle:version, and I'm not sure why.

Attributes

Application Name
Name of the application
Homepage URL
Link to homepage
Download URL
Link to file download
Appcast (Optional)
Link to Sparkle-RSS feed.
Developer (optional)
Name of the developer.
License
Dropdown list of these options: Freeware, Shareware, GPL, LGPL, BSD License, Charityware, Other Open Source, Commercial with demo
Keywords
Comma-separated list of keywords.
Description
Description of the application.
Universal binary
True/False for Intel/PPC compatibility.
Icon
32x32 pixel application icon.
Screenshot
Image of the application.

VersionTracker


MySQL Downloads


MacUpdate


WordPress Plugins

WordPress generates plugin pages from a readme.txt file included with the plugin. It has its own validator and format standards.

Attributes

Plugin name
The name of the plugin.
Authors
Author field from the plugin file and Contributors field from the readme file.
Version
Version field from the plugin file.
Tags (as in categories)
Tags field from the readme file.
Last updated time
Time of last check in to the appropriate directory (trunk/ or the stable tag directory) after a version number change.
Creation time
Time of first check in.
Rating
A rating up to five stars.
Download link
The URL to download the plugin zip file.
Description
The description of the plugin.

From readme.txt

Contributors
WordPress.org usernames of contributors.
Donate link
Link for receiving donations.
Tags
Comma-separated list of keywords.
Requires at least
WordPress version requirements.
Tested up to
The latest version of WordPress the plugin was tested against.
Stable tag
The stable branch of the plugin to use.
Description
This is the long description. No limit, and you can use Markdown.
Installation
This section describes how to install the plugin and get it working. Typically an ordered list.
Frequently Asked Questions
Questions and answers about the plugin.
Screenshots
An ordered list of screenshot descriptions; screenshot image files should be located in the same directory as readme.txt and named screenshot-#.(png|jpg|jpeg|gif).

Related pages