Some documentation for the usage of the "abstract" element.

diff --git a/doc/BBCode.md b/doc/BBCode.md
index fe7c1481f68f93e94ce7071ecec51a01d9585d50..a45431f586acff6fb19704c71941c3eabfb71683 100644 (file)
--- a/doc/BBCode.md
+++ b/doc/BBCode.md
@@ -143,6 +143,62 @@ Map
 You can embed maps from coordinates or addresses. 
 This require "openstreetmap" addon version 1.3 or newer.
 
 You can embed maps from coordinates or addresses. 
 This require "openstreetmap" addon version 1.3 or newer.
 

+-----------------------------------------------------------
+
+Abstract for longer posts
+-------------------------
+
+If you want to spread your post to several third party networks you can 
+have the problem that these networks have (for example) a length 
+limitation. (Like on Twitter)
+
+Friendica is using a semi intelligent mechanism to generate a fitting 
+abstract. But it can be interesting to define an own abstract that will 
+only be displayed on the external network. This is done with the 
+[abstract]-element. Example:
+
+<pre>[abstract]Totally interesting! A must-see! Please click the link![/abstract]
+I want to tell you a really boring story that you really never wanted 
+to hear.</pre>
+
+Twitter would display the text "Totally interesting! A must-see! Please 
+click the link!". On Friendica you would only see the text after "I 
+want to tell you a really ..."
+
+It is even possible to define abstracts for separate networks:
+
+<pre>
+[abstract]Hi friends Here are my newest pictures![abstract]
+[abstract=twit]Hi my dear Twitter followers. Do you want to see my new 
+pictures?[abstract]
+[abstract=apdn]Helly my dear followers on ADN. I made sone new pictures 
+that I wanted to share with you.[abstract]
+Today I was in the woods and took some real cool pictures ...
+</pre>
+
+For Twitter and App.net the system will use the defined abstracts. For 
+other networks (e.g. when you are using the Statusnet connector) the 
+general abstract element will be used.
+
+If you use (for example) the "buffer" connector to post to Facebook or 
+Google+ you can use this element to define an abstract for a longer 
+blogpost that you don't want to post completely to these networks.
+
+Networks like Facebook or Google+ aren't length limited. For this reason 
+the [abstract] element isn't used. Instead you have to name the explicit 
+network:
+
+<pre>
+[abstract]These days I had a strange encounter ...[abstract]
+[abstract=goog]Helly my dear Google+ followers. You have to read my 
+newest blog post![abstract]
+[abstract=face]Hello my Facebook friends. These days happened something 
+really cool.[abstract]
+While taking pictures in the woods I had a really strange encounter ... </pre>
+
+The [abstract] element isn't working with the native OStatus connection 
+or with connectors where we post the HTML. (Like Tumblr, Wordpress or 
+Pump.io)

 
 Special
 -------
 
 Special
 -------


@@ -150,5 +206,3 @@ Special
 If you need to put literal bbcode in a message, [noparse], [nobb] or [pre] are used to escape bbcode:
 
 <pre>[noparse][b]bold[/b][/noparse]</pre> : [b]bold[/b]
 If you need to put literal bbcode in a message, [noparse], [nobb] or [pre] are used to escape bbcode:
 
 <pre>[noparse][b]bold[/b][/noparse]</pre> : [b]bold[/b]

-
-

diff --git a/doc/de/BBCode.md b/doc/de/BBCode.md
index d3e205f0fa38a1f33b72a78dbe988cfbcf31f060..0856c30e507fff49cccdbf4e73626f8f1ce9fd05 100644 (file)
--- a/doc/de/BBCode.md
+++ b/doc/de/BBCode.md
@@ -145,6 +145,64 @@ eine Karte von [OpenStreetmap](http://openstreetmap.org) eingebettet werden. Zur
 
 oder eine Adresse in obiger Form verwendet werden.
 
 
 oder eine Adresse in obiger Form verwendet werden.
 

+Zusammenfassung für längere Beiträge
+------------------------------------
+
+Wenn man seine Beiträge über mehrere Netzwerke verbreiten möchte, hat 
+man häufig das Problem, dass diese Netzwerke z.B. eine 
+Längenbeschränkung haben. (Z.B. Twitter).
+
+Friendica benutzt zum Erzeugen eines Anreißtextes eine halbwegs 
+intelligente Logik. Es kann aber dennoch von Interesse sein, eine eigene 
+Zusammenfassung zu erstellen, die nur auf dem Fremdnetzwerk dargestellt 
+wird. Dies geschieht mit dem [abstract]-Element. Beispiel:
+
+<pre>[abstract]Total spannend! Unbedingt diesen Link anklicken![/abstract]
+Hier erzähle ich euch eine total langweilige Geschichte, die ihr noch 
+nie hören wolltet.</pre>
+
+Auf Twitter würde das "Total spannend! Unbedingt diesen Link anklicken!" 
+stehen, auf Friendica würde nur der Text nach "Hier erzähle ..." 
+erscheinen.
+
+Es ist sogar möglich, für einzelne Netzwerke eigene Zusammenfassungen zu 
+erstellen:
+
+<pre>
+[abstract]Hallo Leute, hier meine neuesten Bilder![abstract]
+[abstract=twit]Hallo Twitter-User, hier meine neuesten Bilder![abstract]
+[abstract=apdn]Hallo App.net-User, hier meine neuesten Bilder![abstract]
+Ich war heute wieder im Wald unterwegs und habe tolle Bilder geschossen ...
+</pre>
+
+Für Twitter und App.net nimmt das System die entsprechenden Texte. Bei 
+anderen Netzwerken, bei denen der Inhalt gekürzt wird (z.B. beim 
+Statusnet-Connector) wird dann die Zusammenfassung unter [abstract] 
+verwendet.
+
+Wenn man z.B. den "buffer"-Connector verwendet, um nach Facebook oder 
+Google+ zu posten, kann man dieses Element ebenfalls verwenden, wenn man 
+z.B. einen längeren Blogbeitrag erstellt hat, aber ihn nicht komplett in 
+diese Netzwerke posten möchte.
+
+Netzwerke wie Facebook oder Google+ sind nicht in der Postinglänge 
+beschränkt. Aus diesem Grund greift nicht die 
+[abstract]-Zusammenfassung. Stattdessen muss man das Netzwerk explizit 
+angeben:
+
+<pre>
+[abstract]Ich habe neulich wieder etwas erlebt, was ich euch mitteilen möchte.[abstract]
+[abstract=goog]Hallo meine Google+-Kreislinge. Ich habe neulich wieder 
+etwas erlebt, was ich euch mitteilen möchte.[abstract]
+[abstract=face]Hallo Facebook-Freunde! Ich habe neulich wieder etwas 
+erlebt, was ich euch mitteilen möchte.[abstract]
+Beim Bildermachen im Wald habe ich neulich eine interessante Person 
+getroffen ... </pre>
+
+Das [abstract]-Element greift nicht bei der nativen OStatus-Verbindung 
+oder bei Connectoren, die den HTML-Text posten wie z.B. die Connectoren 
+zu Tumblr, Wordpress oder Pump.io.
+

 Spezielle Tags
 -------
 
 Spezielle Tags
 -------