source-code-brainstorming - Revision history

Tantek: /* Alternatives */ provide a more clear separation between current thoughts vs past thoughts, move pre 2025 alternatives to bottom

2026-02-12T21:21:36Z

Alternatives: provide a more clear separation between current thoughts vs past thoughts, move pre 2025 alternatives to bottom

← Older revision		Revision as of 21:21, 12 February 2026
Line 6:		Line 6:

	== Alternatives ==		== Alternatives ==
	~~Summary of prior (pre-~~2025~~) brainstorm~~ alternatives:		=== Current proposed alternatives ===
	* <code>rel=source</code>. Good: short, covers lots of use-cases. Bad: ambiguous term. could be better used to define a source where the information came from. When someone writes an article, which is based on information from somewhere else, <code>rel="source"</code> would be a more appropriate name.		2025+ brainstorming update:
	* <code>rel=code</code>. Good: clearly express a semantic for "the code for the current page is over there". Issues: which code? The HTML, the PHP, something else? Re-proposed in [https://chat.indieweb.org/dev/2025-05-25#t1748200034668000 IndieWeb dev chat 2025-05-25]		* '''<code>rel=code</code>'''. Good: shorter than alternatives, sufficiently unique to convey meaning, clearly express a semantic for "the code for the current page is over there".
	* ~~<code>rel=sourcecode</code>. Good: more specific than others. Bad: naming is less readable with two adjacent words.~~		** alt: <code>rel=source</code>. Good: short, covers lots of use-cases. Bad: ambiguous term. could be better used to define a source where the information came from. When someone writes an article, which is based on information from somewhere else, <code>rel="source"</code> would be a more appropriate name.
	~~2025+ brainstorming additions~~:		** alt: <code>rel=source-code</code>. Good: better than "sourcecode". Bad: Longer than "code" with no discernible benefit.
	* <code>rel=source-code</code>. Good: better than "sourcecode". Bad: Longer than "code" with no discernible benefit.		* '''<code>rel=repository</code>'''. Good: more precise semantic for just the (presumably revision control) repository file for the current page, without asserting a 'code' semantic. From [https://chat.indieweb.org/dev/2025-05-25#t1748200051542500 IndieWeb dev chat 2025-05-25]. Alternatives:
	* <code>rel=repository</code>. Good: more precise semantic for just the (presumably revision control) repository file for the current page, without asserting a 'code' semantic. From [https://chat.indieweb.org/dev/2025-05-25#t1748200051542500 IndieWeb dev chat 2025-05-25]. Alternatives:		** alt: <code>rel=repo</code>. Advantage: shorter. Disadvantage: less obvious.
	** <code>rel=repo</code>. Advantage: shorter. Disadvantage: less obvious.		** alt: <code>rel=vcs</code>. Advantage: even shorter. Disadvantage: acronym, even less obvious.
	** <code>rel=vcs</code>. Advantage: even shorter. Disadvantage: acronym, even less obvious.		* '''<code>rel="code repository"</code>''' to link to the code file for a page in a repository. Good: combine multiple precise semantics to express an even more precise semantic. From [https://chat.indieweb.org/dev/2025-05-25#t1748200073140900 IndieWeb dev chat 2025-05-25].
	* <code>rel="code repository"</code> to link to the code file for a page in a repository. Good: combine multiple precise semantics to express an even more precise semantic. From [https://chat.indieweb.org/dev/2025-05-25#t1748200073140900 IndieWeb dev chat 2025-05-25].		* '''<code>rel="directory repository"</code>''' to link to the folder of the file for a page, in a repository, re-using pre-existing [[rel-directory]] semantics. From [https://chat.indieweb.org/dev/2025-05-25#t1748200111083300 IndieWeb dev chat 2025-05-25].
	* <code>rel="directory repository"</code> to link to the folder of the file for a page, in a repository, re-using pre-existing [[rel-directory]] semantics. From [https://chat.indieweb.org/dev/2025-05-25#t1748200111083300 IndieWeb dev chat 2025-05-25].		* '''<code>rel="repository root"</code>''' (order doesn't matter), or <code>rel="repository home"</code> to link to the repository root (or home) for the file for the current page. From [https://chat.indieweb.org/dev/2025-05-25#t1748200152614400 IndieWeb dev chat 2025-05-25].
	* <code>rel="repository root"</code> (order doesn't matter), or <code>rel="repository home"</code> to link to the repository root (or home) for the file for the current page. From [https://chat.indieweb.org/dev/2025-05-25#t1748200152614400 IndieWeb dev chat 2025-05-25].		* '''<code>rel="edit repository"</code>''' links to the edit state of the file for the current page, in a repository so you can immediately start typing into the text area, in contrast to say plain <code>rel="edit"</code> for when linking to the edit state locally on the page itself like on a MediaWiki install (Wikipedia etc.) that directly shows you a textarea to edit the page you are viewing. Good: similar combination of multiple precise semantics to express both. From [https://chat.indieweb.org/dev/2025-05-25#t1748200217297200 IndieWeb dev chat 2025-05-25].
	* <code>rel="edit repository"</code> links to the edit state of the file for the current page, in a repository so you can immediately start typing into the text area, in contrast to say plain <code>rel="edit"</code> for when linking to the edit state locally on the page itself like on a MediaWiki install (Wikipedia etc.) that directly shows you a textarea to edit the page you are viewing. Good: similar combination of multiple precise semantics to express both. From [https://chat.indieweb.org/dev/2025-05-25#t1748200217297200 IndieWeb dev chat 2025-05-25].
	* ...		* ...

Line 52:		Line 51:

	<code>repository</code> is a modifier that may appear at any point in a rel value.		<code>repository</code> is a modifier that may appear at any point in a rel value.

			=== Summary of alternatives before 2025 ===
			Summary of prior (pre-2025) brainstorm alternatives:
			* <code>rel=source</code>. Good: short, covers lots of use-cases. Bad: ambiguous term. could be better used to define a source where the information came from. When someone writes an article, which is based on information from somewhere else, <code>rel="source"</code> would be a more appropriate name.
			* <code>rel=code</code>. Good: clearly express a semantic for "the code for the current page is over there". Issues: which code? The HTML, the PHP, something else? Re-proposed in [https://chat.indieweb.org/dev/2025-05-25#t1748200034668000 IndieWeb dev chat 2025-05-25]
			* <code>rel=sourcecode</code>. Good: more specific than others. Bad: naming is less readable with two adjacent words.

	== Needs refactoring ==		== Needs refactoring ==

JamesGallagher: make the algorithm more specific, add HTTP Link header description

2025-05-29T22:02:15Z

make the algorithm more specific, add HTTP Link header description

← Older revision		Revision as of 22:02, 29 May 2025
Line 27:		Line 27:
	An algorithm for parsing could be:		An algorithm for parsing could be:

	* Find all <code>link</code> ~~and~~ <code>a</code> tags that contain the <code>edit</code> <code>rel</code> value. Return the first ~~one~~ found. Else, go onto the next step.		* Find all <code>link</code> then <code>a</code> tags that contain the <code>edit</code> <code>rel</code> value.
			** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain <code>rel</code> values of both <code>code</code> and <code>repository</code>. Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain <code>rel</code> values of both <code>code</code> and <code>repository</code>. Return the first one found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain the <code>code</code> <code>rel</code> attribute. Return the first ~~one~~ found. Else, go onto the next step.		** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>directory</code> and <code>repository</code>. Return the first ~~one~~ found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain the <code>code</code> <code>rel</code> attribute.
	* Find all <code>link</code> and <code>a</code> tags that contain the <code>directory</code> <code>rel</code> attribute. Return the first ~~one~~ found. Else, go onto the next step.		** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>home</code> and <code>repository</code>. Return the first ~~one~~ found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>directory</code> and <code>repository</code>.
	* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>root</code> and <code>repository</code>. Return the first ~~one~~ found. Else, go onto the next step.		** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
			* Find all <code>link</code> and <code>a</code> tags that contain the <code>directory</code> <code>rel</code> attribute.
			** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
			* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>home</code> and <code>repository</code>.
			** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
			* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>root</code> and <code>repository</code>.
			** Return the first matching <code>link</code> tag found. If none found, return the first matching <code>a</code> tag found. Else, go onto the next step.
	* If no links are found, return null.		* If no links are found, return null.

			In addition, a check should be done against the HTTP <code>Link></code> headers using the same order of precedence as outlined above:

			* edit
			* code repository
			* code directory
			* home repository
			* root repository

			<code>repository</code> is a modifier that may appear at any point in a rel value.

	== Needs refactoring ==		== Needs refactoring ==

JamesGallagher: change quotes to code blocks

2025-05-29T21:53:02Z

change quotes to code blocks

← Older revision		Revision as of 21:53, 29 May 2025
Line 28:		Line 28:

	* Find all <code>link</code> and <code>a</code> tags that contain the <code>edit</code> <code>rel</code> value. Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain the <code>edit</code> <code>rel</code> value. Return the first one found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain <code>rel</code> values of both "code" and "repository". Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain <code>rel</code> values of both <code>code</code> and <code>repository</code>. Return the first one found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain the <code>code</code> <code>rel</code> attribute. Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain the <code>code</code> <code>rel</code> attribute. Return the first one found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both "directory" and "repository". Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>directory</code> and <code>repository</code>. Return the first one found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain the <code>directory</code> <code>rel</code> attribute. Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain the <code>directory</code> <code>rel</code> attribute. Return the first one found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both "home" and "repository". Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>home</code> and <code>repository</code>. Return the first one found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both "root" and "repository". Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain have <code>rel</code> values of both <code>root</code> and <code>repository</code>. Return the first one found. Else, go onto the next step.
	* If no links are found, return null.		* If no links are found, return null.

JamesGallagher: /* Potential algorithm for finding a representative URL for editing/viewing source */

2025-05-29T21:51:51Z

Potential algorithm for finding a representative URL for editing/viewing source

← Older revision		Revision as of 21:51, 29 May 2025
Line 27:		Line 27:
	An algorithm for parsing could be:		An algorithm for parsing could be:

	* Find all <code>link</code> and <code>a</code> tags that contain the <code>edit</code> <code>rel ~~value~~</code>. Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain the <code>edit</code> <code>rel</code> value. Return the first one found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain <code>rel</code> values of both "code" and "repository". Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain <code>rel</code> values of both "code" and "repository". Return the first one found. Else, go onto the next step.
	* Find all <code>link</code> and <code>a</code> tags that contain the <code>code</code> <code>rel</code> attribute. Return the first one found. Else, go onto the next step.		* Find all <code>link</code> and <code>a</code> tags that contain the <code>code</code> <code>rel</code> attribute. Return the first one found. Else, go onto the next step.

JamesGallagher: add proposed algorithm

2025-05-29T21:51:21Z

add proposed algorithm

@@ Line 20: / Line 20: @@
 * <code>rel="edit repository"</code> links to the edit state of the file for the current page, in a repository so you can immediately start typing into the text area, in contrast to say plain <code>rel="edit"</code> for when linking to the edit state locally on the page itself like on a MediaWiki install (Wikipedia etc.) that directly shows you a textarea to edit the page you are viewing. Good: similar combination of multiple precise semantics to express both. From [https://chat.indieweb.org/dev/2025-05-25#t1748200217297200 IndieWeb dev chat 2025-05-25].
 * ...
 == Needs refactoring ==

Tantek: /* Alternatives */ add some brainstorms from yesterday with indieweb dev chat citations

2025-05-26T23:51:08Z

Alternatives: add some brainstorms from yesterday with indieweb dev chat citations

← Older revision		Revision as of 23:51, 26 May 2025
Line 8:		Line 8:
	Summary of prior (pre-2025) brainstorm alternatives:		Summary of prior (pre-2025) brainstorm alternatives:
	* <code>rel=source</code>. Good: short, covers lots of use-cases. Bad: ambiguous term. could be better used to define a source where the information came from. When someone writes an article, which is based on information from somewhere else, <code>rel="source"</code> would be a more appropriate name.		* <code>rel=source</code>. Good: short, covers lots of use-cases. Bad: ambiguous term. could be better used to define a source where the information came from. When someone writes an article, which is based on information from somewhere else, <code>rel="source"</code> would be a more appropriate name.
	* <code>rel=code</code>. Good: clearly express a semantic for "the code for the current page is over there". Issues: which code? The HTML, the PHP, something else?		* <code>rel=code</code>. Good: clearly express a semantic for "the code for the current page is over there". Issues: which code? The HTML, the PHP, something else? Re-proposed in [https://chat.indieweb.org/dev/2025-05-25#t1748200034668000 IndieWeb dev chat 2025-05-25]
	* <code>rel=sourcecode</code>. Good: more specific than others. Bad: naming is less readable with two adjacent words.		* <code>rel=sourcecode</code>. Good: more specific than others. Bad: naming is less readable with two adjacent words.
			2025+ brainstorming additions:
			* <code>rel=source-code</code>. Good: better than "sourcecode". Bad: Longer than "code" with no discernible benefit.
			* <code>rel=repository</code>. Good: more precise semantic for just the (presumably revision control) repository file for the current page, without asserting a 'code' semantic. From [https://chat.indieweb.org/dev/2025-05-25#t1748200051542500 IndieWeb dev chat 2025-05-25]. Alternatives:
			** <code>rel=repo</code>. Advantage: shorter. Disadvantage: less obvious.
			** <code>rel=vcs</code>. Advantage: even shorter. Disadvantage: acronym, even less obvious.
			* <code>rel="code repository"</code> to link to the code file for a page in a repository. Good: combine multiple precise semantics to express an even more precise semantic. From [https://chat.indieweb.org/dev/2025-05-25#t1748200073140900 IndieWeb dev chat 2025-05-25].
			* <code>rel="directory repository"</code> to link to the folder of the file for a page, in a repository, re-using pre-existing [[rel-directory]] semantics. From [https://chat.indieweb.org/dev/2025-05-25#t1748200111083300 IndieWeb dev chat 2025-05-25].
			* <code>rel="repository root"</code> (order doesn't matter), or <code>rel="repository home"</code> to link to the repository root (or home) for the file for the current page. From [https://chat.indieweb.org/dev/2025-05-25#t1748200152614400 IndieWeb dev chat 2025-05-25].
			* <code>rel="edit repository"</code> links to the edit state of the file for the current page, in a repository so you can immediately start typing into the text area, in contrast to say plain <code>rel="edit"</code> for when linking to the edit state locally on the page itself like on a MediaWiki install (Wikipedia etc.) that directly shows you a textarea to edit the page you are viewing. Good: similar combination of multiple precise semantics to express both. From [https://chat.indieweb.org/dev/2025-05-25#t1748200217297200 IndieWeb dev chat 2025-05-25].
	* ...		* ...

Tantek: add summary of brainstorm alternatives from before this year

2025-05-26T05:12:38Z

add summary of brainstorm alternatives from before this year

← Older revision		Revision as of 05:12, 26 May 2025
Line 4:		Line 4:
	* [[source-code-examples]]		* [[source-code-examples]]
	* [[source-code-formats]]		* [[source-code-formats]]

			== Alternatives ==
			Summary of prior (pre-2025) brainstorm alternatives:
			* <code>rel=source</code>. Good: short, covers lots of use-cases. Bad: ambiguous term. could be better used to define a source where the information came from. When someone writes an article, which is based on information from somewhere else, <code>rel="source"</code> would be a more appropriate name.
			* <code>rel=code</code>. Good: clearly express a semantic for "the code for the current page is over there". Issues: which code? The HTML, the PHP, something else?
			* <code>rel=sourcecode</code>. Good: more specific than others. Bad: naming is less readable with two adjacent words.
			* ...

	== Needs refactoring ==		== Needs refactoring ==

Tantek: needs refactoring

2025-05-25T22:20:27Z

needs refactoring

← Older revision		Revision as of 22:20, 25 May 2025
Line 4:		Line 4:
	* [[source-code-examples]]		* [[source-code-examples]]
	* [[source-code-formats]]		* [[source-code-formats]]

			== Needs refactoring ==
			{{note\|The rest of this page needs some analysis and refactoring, moving e.g. "examples demonstrate situations where an explicit rel value could be used" to the [[source-code-examples]] page}}

	== Usage ==		== Usage ==

Tantek: rel=source related post

2025-05-25T22:18:30Z

rel=source related post

← Older revision		Revision as of 22:18, 25 May 2025
Line 43:		Line 43:

	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.		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.

			Related post:
			* https://chat.indieweb.org/microformats/2021-05-20#t1621544703548300

	=== Relations between one URI and a linked URI ===		=== Relations between one URI and a linked URI ===

Tantek: link to broader source-code format effort

2025-05-25T22:08:28Z

link to broader source-code format effort

← Older revision		Revision as of 22:08, 25 May 2025
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.		Background research:
			* [[source-code-examples]]
			* [[source-code-formats]]

	== Usage ==		== Usage ==
Line 55:		Line 57:
	* [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].		* [http://refresh-dc.org Refresh DC] links to [https://github.com/jgarber623/refresh-dc.org the source code on GitHub].

			== See Also ==
			* [[source-code]]
			* [[source-code-examples]]
			* [[source-code-formats]]