publish: document order of precedence for interpreting original post …

…type basically post type discovery, but with tag replies added. for #849 #832
snarfed · Nov 25, 2018 · b42365f · b42365f
1 parent c2c084b
commit b42365f
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/static/style.css b/static/style.css
@@ -385,7 +385,7 @@ iframe#twitter-widget-0 {
   font-weight: bold;
 }
 
-.answer li {
+.answer ul li, .answer ol {
   margin-bottom: .5em;
 }
 

diff --git a/templates/about.html b/templates/about.html
@@ -89,8 +89,7 @@
 <br />
 <p><em>Publishing</em></p>
 <li><a href="#publishing">What do you mean, <em>publishing</em>?</a></li>
-<li><a href="#microformats">How does it decide which parts of my web
-  page to include?</a></li>
+<li><a href="#microformats">How does it decide which parts of my web page to include?</a></li>
 <li><a href="#publish-types">What can I publish, exactly?</a></li>
 <li><a href="#webmentions">Can I do this automatically, whenever
   I post something new on my web site?</a></li>
@@ -110,6 +109,7 @@
 <li><a href="#ignore-formatting">Can I disable the plain text whitespace and
   formatting?</a></li>
 <li><a href="#silo-content">I want more control over the text that gets posted.</li>
+<li><a href="#multiple-types">What if my original post does more than one thing?</li>
 <li><a href="#short-link">Can I include a short link instead of the full link?</a></li>
 <li><a href="#response">How does Bridgy respond to webmentions?</a></li>
 <li><a href="#error-response">How about error responses?</a></li>
@@ -1060,6 +1060,23 @@ <h3 id="publish">Publishing</h3>
 <p>If you use this, Bridgy will still include a link to your post. <a href="#omit-link">You can change that with <code>omit-link</code>.</a> It will also still truncate your text if it's <a href="https://developer.twitter.com/en/docs/basics/counting-characters">over 280 characters</a>. You can always <a href="#try+it">preview your post first</a> to see how Bridgy will handle it!</p>
 </li>
 
+<li id="multiple-types" class="question">What if my original post does more than one thing?
+</li>
+<li class="answer">
+<p>Bridgy Publish always interprets an original post on your web site as a single thing. It would be <a href="https://github.com/snarfed/bridgy/issues/832">difficult</a>, at best, to translate a single publish request to multiple actions in a silo consistently and safely, so we don't currently try.</p>
+<p>Bridgy Publish largely follows the <a href="https://ptd.spec.indieweb.org/#algorithm">Post Type Discovery</a> standard to map a microformats2 post on your web site to a single thing. There's one exception: PTD doesn't currently handle <a href="https://indieweb.org/tag-reply">tag replies</a>, but we do, so if your post has <code>u-tag-of</code>, it's interpreted as a tag reply. So, the <a href="https://ptd.spec.indieweb.org/#algorithm">Post Type Algorithm</a> results in this overall order of precedence:</p>
+<ol>
+<li><a href="https://indieweb.org/tag-reply">tag reply</a></li>
+<li><a href="https://indieweb.org/rsvp">RSVP</a></li>
+<li><a href="https://indieweb.org/repost">repost</a></li>
+<li><a href="https://indieweb.org/like">like</a></li>
+<li><a href="https://indieweb.org/reply">reply</a></li>
+<li><a href="https://indieweb.org/post">post</a></li>
+</ol>
+<p>So, for example, if you try publish a post that's both a like and a repost, Bridgy translates it to a repost.</p>
+<p> Replies with tag replies (ie <code>u-tag-of</code>) are an exception. <a href="https://github.com/snarfed/bridgy/issues/832">They currently return an error.</a></p>
+</li>
+
 <li id="short-link" class="question">Can I include a short link instead of the full link?</li>
 <li class="answer">
 <p>Sure! Just enter the short link in the URL text box. Or if you're