source-brainstorming: Difference between revisions
No edit summary |
m (Replace <entry-title> with {{DISPLAYTITLE:}}) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: Source Brainstorming }} | |||
Per the microformats [[process]], this page is for brainstorming about ideas, proposals, constraints, requirements for a microformat for indicating the link relationship between a document (or site) and its source code. | Per the microformats [[process]], this page is for brainstorming about ideas, proposals, constraints, requirements for a microformat for indicating the link relationship between a document (or site) and its source code. | ||
| Line 25: | Line 25: | ||
<li><code>sourcecode</code></li> | <li><code>sourcecode</code></li> | ||
</ol> | </ol> | ||
=== Use when linking to project source code === | |||
Could this really be used to link to a project’s (rather than the current document’s) source code? | |||
Using the Unison.js example, with all HTML attributes removed except <code>rel</code> and <code>href</code>: | |||
<pre><nowiki> | |||
<a rel="source" href="https://github.com/bjork24/Unison">View on GitHub</a> | |||
</nowiki></pre> | |||
Following the [[rel-faq]], this would be interpreted as: | |||
:The resource indicated by https://github.com/bjork24/Unison is a "source" for the current document. | |||
But it isn’t. [http://responsivedesign.is/resources/javascript-jquery/unison.js The Unison.js project page on responsivedesign.is] does not seem to use Unison.js in any way. | |||
=== Relations between one URI and a linked URI === | |||
To think about the relations in between the current resource (URI) and the linked one, a way is to imagine what would be the "title" attribute that would help users take an action on the link. Basically, we are telling something along the line: "Explore the hosted source code of this project we are talking about on this page." The relation between this current resource I'm reading and the resource I'm linking to is more of a "owl:seeAlso" aka additional information, but it's not really a relation which is related to the source code. In the past, it would have been simply "download the gzipped tarball". Maybe there is no real usage for a meaningful "rel" value. | |||
== Examples == | == Examples == | ||
| Line 34: | Line 54: | ||
* [http://tom.preston-werner.com/ Tom Preston-Warner] links to [http://github.com/mojombo his Github account]. | * [http://tom.preston-werner.com/ Tom Preston-Warner] links to [http://github.com/mojombo his Github account]. | ||
* [http://responsivedesign.is/resources/javascript-jquery/unison.js The Unison.js project] links to [https://github.com/bjork24/Unison the source code on Github] and [https://github.com/bjork24/Unison/archive/master.zip a direct link to download a .zip file of the source code]. | * [http://responsivedesign.is/resources/javascript-jquery/unison.js The Unison.js project] links to [https://github.com/bjork24/Unison the source code on Github] and [https://github.com/bjork24/Unison/archive/master.zip a direct link to download a .zip file of the source code]. | ||
* [http://refresh-dc.org Refresh DC] links to [https://github.com/jgarber623/refresh-dc.org the source code on GitHub]. | |||
Latest revision as of 16:33, 18 July 2020
Per the microformats process, this page is for brainstorming about ideas, proposals, constraints, requirements for a microformat for indicating the link relationship between a document (or site) and its source code.
Usage
<a href="https://github.com/adactio/html5forwebdesigners" rel="source">the source for this book</a>
<link href="https://github.com/adactio/html5forwebdesigners" rel="source" />
Use Cases
When an author links to a project's (or document's) source code (e.g. on GitHub, Google Code, etc.) a rel value of "source" could be used to explicitly define that relationship.
Discussions
rel="code"
source could be better used to define a source where the information came from. When someone writes an article, which is based on informations somewhere else, rel="source" would be a more appropriate name.
Better naming recommendations for the case of this rel-Attribute:
codesourcecode
Use when linking to project source code
Could this really be used to link to a project’s (rather than the current document’s) source code?
Using the Unison.js example, with all HTML attributes removed except rel and href:
<a rel="source" href="https://github.com/bjork24/Unison">View on GitHub</a>
Following the rel-faq, this would be interpreted as:
- The resource indicated by https://github.com/bjork24/Unison is a "source" for the current document.
But it isn’t. The Unison.js project page on responsivedesign.is does not seem to use Unison.js in any way.
Relations between one URI and a linked URI
To think about the relations in between the current resource (URI) and the linked one, a way is to imagine what would be the "title" attribute that would help users take an action on the link. Basically, we are telling something along the line: "Explore the hosted source code of this project we are talking about on this page." The relation between this current resource I'm reading and the resource I'm linking to is more of a "owl:seeAlso" aka additional information, but it's not really a relation which is related to the source code. In the past, it would have been simply "download the gzipped tarball". Maybe there is no real usage for a meaningful "rel" value.
Examples
These examples demonstrate situations where an explicit rel value could be used to mark up an existing document (or project's) link to its source.
- Dan Eden's website links to the source code on GitHub.
- Dan Mall's website links to the source code on GitHub.
- Tom Preston-Warner links to his Github account.
- The Unison.js project links to the source code on Github and a direct link to download a .zip file of the source code.
- Refresh DC links to the source code on GitHub.