rel-edit - Revision history

Tantek: /* Publishers */ CSSWG wiki

2025-05-26T23:15:36Z

Publishers: CSSWG wiki

← Older revision		Revision as of 23:15, 26 May 2025
Line 39:		Line 39:
	* Supabase documentation ([https://supabase.com/docs/guides/database/overview example article])		* Supabase documentation ([https://supabase.com/docs/guides/database/overview example article])
	* [https://airportpianos.org airportpianos.org]		* [https://airportpianos.org airportpianos.org]
			* https://wiki.csswg.org/

	== Tools ==		== Tools ==

JamesGallagher: add "when to add" section

2025-05-26T09:30:53Z

add "when to add" section

← Older revision		Revision as of 09:30, 26 May 2025
Line 1:		Line 1:
	{{stub}}		{{stub}}

	'''<dfn>rel=edit</dfn>''' is for linking to a page to a URL that a browser can load for the user to edit that page.		'''<dfn>rel=edit</dfn>''' is for linking to a page to a URL that a browser can load for the user to edit that page.

	== Definition ==		== Definition ==
Line 19:		Line 19:
	document.querySelector("link[rel=edit], a[rel=edit]")		document.querySelector("link[rel=edit], a[rel=edit]")
	</pre>		</pre>

			== When to add a rel=edit relation to a link ==

			rel=edit must only be published on a page if the user can access the edit page without additional authentication. This is important so that rel=edit links take a user directly to an editing interface.

			A rel=edit relation could be added to a page if the page is editable:

			* Publicly (i.e. a page on an open wiki), or;
			* To the user viewing the page because they are signed in (i.e. a blog post on a private site where the user is signed in as admin).

	== Use Cases ==		== Use Cases ==

Tantek: some prose edits, user visible link guidance, Edit link or pencil icon, separate Consumers into Tools (for users) vs Libraries (for devs), more subheads

2025-05-23T17:02:34Z

some prose edits, user visible link guidance, Edit link or pencil icon, separate Consumers into Tools (for users) vs Libraries (for devs), more subheads

← Older revision		Revision as of 17:02, 23 May 2025
Line 22:		Line 22:
	== Use Cases ==		== Use Cases ==

	rel=edit offers a standard way to indicate a page is editable. This relation then be identified by a browser extension or a bookmarklet and used to both infer that a page is editable and ~~point~~ the user to the page ~~they can use to edit a document~~.		rel=edit offers a standard way to indicate a page is editable by the user.

			This relation then be identified by a browser, browser extension, or a bookmarklet and used to both infer that a page is editable and autodiscover the page to link to for the user to edit the page.

	== Publishers ==		== Publishers ==
			Websites supporting rel=edit:
	* Supabase documentation ([https://supabase.com/docs/guides/database/overview example article])		* Supabase documentation ([https://supabase.com/docs/guides/database/overview example article])
	* [https://airportpianos.org airportpianos.org]		* [https://airportpianos.org airportpianos.org]

	== ~~Consumers~~ ==		== Tools ==
			Tools that users can use to edit pages marked up with rel=edit:
	* [https://github.com/splitbrain/universaleditbutton Universal Edit Button]		* [https://github.com/splitbrain/universaleditbutton Universal Edit Button]
	* [https://jamesg.blog/2025/05/09/extending-my-edit-web-page-bookmarklet Blog post describing rel=edit parsing in a bookmarklet]		* [https://jamesg.blog/2025/05/09/extending-my-edit-web-page-bookmarklet Blog post describing rel=edit parsing in a bookmarklet]
	* The Python indieweb-utils package implements a <code>discover_edit_links</code> function to ~~discover~~ the rel=edit for a page.		* [https://github.com/capjamesg/edit-button-extension Edit button extension] (browser add-on)

			== Libraries ==
			Libraries developers or extensions can use to detect rel=edit:
			* The Python indieweb-utils package implements a <code>discover_edit_links</code> function to autodiscover the rel=edit for a page.
	** Implementation: https://github.com/capjamesg/indieweb-utils/blob/main/src/indieweb_utils/utils/rel_edit.py#L7		** Implementation: https://github.com/capjamesg/indieweb-utils/blob/main/src/indieweb_utils/utils/rel_edit.py#L7
	* [https://github.com/~~capjamesg~~/~~edit-button-extension~~ Edit ~~button~~ extension]		* [https://github.com/splitbrain/universaleditbutton/blob/master/content.js#L6 The Universal Edit Button extension searches for rel=edit.]

	== Prior Art ==		== Prior Art ==
			=== Earlier proposal ===
	rel=edit was raised in Bug 19068 “[https://www.w3.org/Bugs/Public/show_bug.cgi?id=19068 Add rel="edit" to list of defined types]” in the W3C public Bugzilla to the WHAT WG:		rel=edit was raised in Bug 19068 “[https://www.w3.org/Bugs/Public/show_bug.cgi?id=19068 Add rel="edit" to list of defined types]” in the W3C public Bugzilla to the WHAT WG:

Line 50:		Line 56:

	As of May 10th, 2025, Wikipedia does not publish a rel=edit on the main Edit link on pages, but still publishes the `application/x-wiki` syntax.		As of May 10th, 2025, Wikipedia does not publish a rel=edit on the main Edit link on pages, but still publishes the `application/x-wiki` syntax.

	~~[https://github.com/splitbrain/universaleditbutton/blob/master/content.js#L6 The Universal Edit Button extension searches for rel=edit.]~~

	=== rel=alternate type=application/x-wiki ===		=== rel=alternate type=application/x-wiki ===

	MediaWiki supports the following syntax to indicate that the linked resource lets you edit the current page:		MediaWiki supports the following syntax to indicate that the linked resource lets you edit the current page:

Line 68:		Line 71:
	Because of its support in the MediaWiki engine, this markup is on Wikipedia pages.		Because of its support in the MediaWiki engine, this markup is on Wikipedia pages.

	With that said, this syntax does not extend to anchor links, unlike the proposed rel=edit. The rel=alternate syntax means you have to add another tag instead of marking up existing, human-~~readable text~~ on the page via a rel=edit on an anchor.		With that said, this syntax does not extend to anchor links, unlike the proposed rel=edit. The rel=alternate syntax means you have to add another tag instead of marking up existing, human-clickable link on the page via a rel=edit on an anchor.

	=== rel=edit in Atom ===		=== rel=edit in Atom ===
Line 108:		Line 111:
	=== Public vs. private distinction ===		=== Public vs. private distinction ===

	rel=edit should only be applied to links that the current user can use to edit a page. If rel=edit is applied to a link on a public page, it means anyone can contribute to the page. This may be the case for a wiki or a documentation site, for example. If rel=edit is applied to a link on a private page, it means that anyone viewing that page can edit it.		rel=edit should only be applied to links that the current user can use to edit a page.

			If rel=edit is applied to a link on a public page, it means anyone can contribute to the page. This may be the case for a wiki or a documentation site, for example. If rel=edit is applied to a link on a private page, it means that anyone viewing that page can edit it.

	rel=edit implies a page is editable. Users should not encounter a rel=edit link that they have no means to access.		rel=edit implies a page is editable. Users should not encounter a rel=edit link that they have no means to access.

			A good guideline is:
			* if a page has an existing human interface element like a clickable <samp>Edit</samp> link or pencil (✏️) icon or emoji, then that link should be marked up with rel=edit. Otherwise if a page does not show any visual indicator that it can be edited, avoid using rel=edit.

	== See Also ==		== See Also ==

	* [[User:Tantek]]'s [https://indieweb.org/wiki-projects brainstorm of a wiki based on static pages and HTTP headers notes]: <blockquote>a page could link to its editing interface/version/query parameter with a rel link as well, e.g. '''<code>rel=edit</code>''', which has been previously proposed as part of Universal Edit Button: links for AJAX-driven edits but could be used for server-based editing state as well. E.g. <code>href="?edit=1"</code>. Again this might be best sent as an HTTP Link Header.</blockquote>'''Emphasis''' added.		* [[User:Tantek]]'s [https://indieweb.org/wiki-projects brainstorm of a wiki based on static pages and HTTP headers notes]: <blockquote>a page could link to its editing interface/version/query parameter with a rel link as well, e.g. '''<code>rel=edit</code>''', which has been previously proposed as part of Universal Edit Button: links for AJAX-driven edits but could be used for server-based editing state as well. E.g. <code>href="?edit=1"</code>. Again this might be best sent as an HTTP Link Header.</blockquote>'''Emphasis''' added.

JamesGallagher: add supabase as a publisher

2025-05-23T11:44:31Z

add supabase as a publisher

← Older revision		Revision as of 11:44, 23 May 2025
Line 26:		Line 26:
	== Publishers ==		== Publishers ==

			* Supabase documentation ([https://supabase.com/docs/guides/database/overview example article])
	* [https://airportpianos.org airportpianos.org]		* [https://airportpianos.org airportpianos.org]

JamesGallagher: add https://github.com/capjamesg/edit-button-extension

2025-05-23T11:43:30Z

add https://github.com/capjamesg/edit-button-extension

← Older revision		Revision as of 11:43, 23 May 2025
Line 34:		Line 34:
	* The Python indieweb-utils package implements a <code>discover_edit_links</code> function to discover the rel=edit for a page.		* The Python indieweb-utils package implements a <code>discover_edit_links</code> function to discover the rel=edit for a page.
	** Implementation: https://github.com/capjamesg/indieweb-utils/blob/main/src/indieweb_utils/utils/rel_edit.py#L7		** Implementation: https://github.com/capjamesg/indieweb-utils/blob/main/src/indieweb_utils/utils/rel_edit.py#L7
			* [https://github.com/capjamesg/edit-button-extension Edit button extension]

	== Prior Art ==		== Prior Art ==

JamesGallagher: rename heading

2025-05-23T11:42:24Z

rename heading

← Older revision		Revision as of 11:42, 23 May 2025
Line 102:		Line 102:
	Every site has its own way of indicating that a page is editable. Among the sites that allow editing there is inconsistency in where edit links are placed and the language used. For example, Wikipedia uses “Edit” whereas the GitHub documentation uses “Make a contribution”.		Every site has its own way of indicating that a page is editable. Among the sites that allow editing there is inconsistency in where edit links are placed and the language used. For example, Wikipedia uses “Edit” whereas the GitHub documentation uses “Make a contribution”.

	== ~~Brainstorming~~ ==		== Open questions ==

	=== Public vs. private distinction ===		=== Public vs. private distinction ===

JamesGallagher: add brainstorming on public vs. private distinction

2025-05-22T09:35:19Z

add brainstorming on public vs. private distinction

← Older revision		Revision as of 09:35, 22 May 2025
Line 101:		Line 101:

	Every site has its own way of indicating that a page is editable. Among the sites that allow editing there is inconsistency in where edit links are placed and the language used. For example, Wikipedia uses “Edit” whereas the GitHub documentation uses “Make a contribution”.		Every site has its own way of indicating that a page is editable. Among the sites that allow editing there is inconsistency in where edit links are placed and the language used. For example, Wikipedia uses “Edit” whereas the GitHub documentation uses “Make a contribution”.

			== Brainstorming ==

			=== Public vs. private distinction ===

			rel=edit should only be applied to links that the current user can use to edit a page. If rel=edit is applied to a link on a public page, it means anyone can contribute to the page. This may be the case for a wiki or a documentation site, for example. If rel=edit is applied to a link on a private page, it means that anyone viewing that page can edit it.

			rel=edit implies a page is editable. Users should not encounter a rel=edit link that they have no means to access.

	== See Also ==		== See Also ==

	* [[User:Tantek]]'s [https://indieweb.org/wiki-projects brainstorm of a wiki based on static pages and HTTP headers notes]: <blockquote>a page could link to its editing interface/version/query parameter with a rel link as well, e.g. '''<code>rel=edit</code>''', which has been previously proposed as part of Universal Edit Button: links for AJAX-driven edits but could be used for server-based editing state as well. E.g. <code>href="?edit=1"</code>. Again this might be best sent as an HTTP Link Header.</blockquote>'''Emphasis''' added.		* [[User:Tantek]]'s [https://indieweb.org/wiki-projects brainstorm of a wiki based on static pages and HTTP headers notes]: <blockquote>a page could link to its editing interface/version/query parameter with a rel link as well, e.g. '''<code>rel=edit</code>''', which has been previously proposed as part of Universal Edit Button: links for AJAX-driven edits but could be used for server-based editing state as well. E.g. <code>href="?edit=1"</code>. Again this might be best sent as an HTTP Link Header.</blockquote>'''Emphasis''' added.

JamesGallagher: /* Consumers */ add indieweb-utils

2025-05-11T07:58:24Z

Consumers: add indieweb-utils

← Older revision		Revision as of 07:58, 11 May 2025
Line 32:		Line 32:
	* [https://github.com/splitbrain/universaleditbutton Universal Edit Button]		* [https://github.com/splitbrain/universaleditbutton Universal Edit Button]
	* [https://jamesg.blog/2025/05/09/extending-my-edit-web-page-bookmarklet Blog post describing rel=edit parsing in a bookmarklet]		* [https://jamesg.blog/2025/05/09/extending-my-edit-web-page-bookmarklet Blog post describing rel=edit parsing in a bookmarklet]
			* The Python indieweb-utils package implements a <code>discover_edit_links</code> function to discover the rel=edit for a page.
			** Implementation: https://github.com/capjamesg/indieweb-utils/blob/main/src/indieweb_utils/utils/rel_edit.py#L7

	== Prior Art ==		== Prior Art ==

JamesGallagher: add `to link and a text`


2025-05-11T06:42:34Z
add <code> to link and a text

				
				
				
				
				
				← Older revision
				Revision as of 06:42, 11 May 2025
				
Line 5:
Line 5:
== Definition == == Definition ==



rel=edit can be applied to `link` or `a` tags, like so: rel=edit can be applied to <code>link</code> or <code>a</code> tags, like so:



<pre> <pre>



JamesGallagher: fix typo, add UEB to consumers
2025-05-11T06:16:09Z
fix typo, add UEB to consumers

				
				
				
				
				
				← Older revision
				Revision as of 06:16, 11 May 2025
				
Line 17:
Line 17:



<pre> <pre>
document.querySelector("link[rel=edit], link[rel=edit]") document.querySelector("link[rel=edit], a[rel=edit]")
</pre> </pre>



Line 30:
Line 30:
== Consumers == == Consumers ==



* [https://github.com/splitbrain/universaleditbutton Universal Edit Button]
* [https://jamesg.blog/2025/05/09/extending-my-edit-web-page-bookmarklet Blog post describing rel=edit parsing in a bookmarklet] * [https://jamesg.blog/2025/05/09/extending-my-edit-web-page-bookmarklet Blog post describing rel=edit parsing in a bookmarklet]

← Older revision		Revision as of 06:42, 11 May 2025
Line 5:		Line 5:
	== Definition ==		== Definition ==

	rel=edit can be applied to `link` or `a` tags, like so:		rel=edit can be applied to <code>link</code> or <code>a</code> tags, like so:

	<pre>		<pre>

← Older revision		Revision as of 06:16, 11 May 2025
Line 17:		Line 17:

	<pre>		<pre>
	document.querySelector("link[rel=edit], ~~link~~[rel=edit]")		document.querySelector("link[rel=edit], a[rel=edit]")
	</pre>		</pre>

Line 30:		Line 30:
	== Consumers ==		== Consumers ==

			* [https://github.com/splitbrain/universaleditbutton Universal Edit Button]
	* [https://jamesg.blog/2025/05/09/extending-my-edit-web-page-bookmarklet Blog post describing rel=edit parsing in a bookmarklet]		* [https://jamesg.blog/2025/05/09/extending-my-edit-web-page-bookmarklet Blog post describing rel=edit parsing in a bookmarklet]