diff --git a/doc/BBCode.md b/doc/BBCode.md index 7068f1691..fe7c1481f 100644 --- a/doc/BBCode.md +++ b/doc/BBCode.md @@ -1,146 +1,154 @@ -Friendica BBCode tags reference -======================== - -* [Home](help) - -Inline ------ - - -
[b]bold[/b]: bold - -
[i]italic[/i]: italic - -
[u]underlined[/u]: underlined - -
[s]strike[/s]:
[color=red]red[/color]: red - -
[url=http://www.friendica.com]Friendica[/url]: Friendica - -
[img]http://friendica.com/sites/default/files/friendika-32.png[/img]: - -
[size=xx-small]small text[/size]: small text - -
[size=xx-large]big text[/size]: big text - -
[size=20]exact size[/size] (size can be any number, in pixel): exact size - - - - - - - -Block ------ - -
[code]code[/code]- -
code
-
-- -
[quote]quote[/quote]- -
quote- -
- -
[quote=Author]Author? Me? No, no, no...[/quote]- -Author wrote:
Author? Me? No, no, no...- -
- -
[center]centered text[/center]- -
- -**Table** -
[table border=1] - [tr] - [th]Tables now[/th] - [/tr] - [tr] - [td]Have headers[/td] - [/tr] -[/table]- -
Tables now |
---|
Have headers |
- -**List** - -
[list] - [*] First list element - [*] Second list element -[/list]-
[ol] - [*] First list element - [*] Second list element -[/ol]-
[list=1]: decimal - -
[list=i]: lover case roman - -
[list=I]: upper case roman - -
[list=a]: lover case alphabetic - -
[list=A]: upper case alphabetic - - - - -Embed ------- - -You can embed video, audio and more in a message. - -
[video]url[/video]-
[audio]url[/audio]- -Where *url* can be an url to youtube, vimeo, soundcloud, or other sites wich supports oembed or opengraph specifications. -*url* can be also full url to an ogg file. HTML5 tag will be used to show it. - -
[url]*url*[/url]- -If *url* supports oembed or opengraph specifications the embedded object will be shown (eg, documents from scribd). -Page title with a link to *url* will be shown. - -Map ---- - -
[map]address[/map]-
[map=lat,long]- -You can embed maps from coordinates or addresses. -This require "openstreetmap" addon version 1.3 or newer. - - -Special -------- - -If you need to put literal bbcode in a message, [noparse], [nobb] or [pre] are used to escape bbcode: - -
[noparse][b]bold[/b][/noparse]: [b]bold[/b] - - +Friendica BBCode tags reference +======================== + +* [Home](help) + +Inline +----- + + +
[b]bold[/b]: bold + +
[i]italic[/i]: italic + +
[u]underlined[/u]: underlined + +
[s]strike[/s]:
[color=red]red[/color]: red + +
[url=http://www.friendica.com]Friendica[/url]: Friendica + +
[img]http://friendica.com/sites/default/files/friendika-32.png[/img]: + +
[size=xx-small]small text[/size]: small text + +
[size=xx-large]big text[/size]: big text + +
[size=20]exact size[/size] (size can be any number, in pixel): exact size + + + + + + + +Block +----- + +
[code]code[/code]+ +
code
+
++ +
[quote]quote[/quote]+ +
quote+ +
+ +
[quote=Author]Author? Me? No, no, no...[/quote]+ +Author wrote:
Author? Me? No, no, no...+ +
+ +
[center]centered text[/center]+ +
+ +
You should not read any further if you want to be surprised.[spoiler]There is a happy end.[/spoiler]+ +You should not read any further if you want to be surprised.
+ +**Table** +
[table border=1] + [tr] + [th]Tables now[/th] + [/tr] + [tr] + [td]Have headers[/td] + [/tr] +[/table]+ +
Tables now |
---|
Have headers |
+ +**List** + +
[list] + [*] First list element + [*] Second list element +[/list]+
[ol] + [*] First list element + [*] Second list element +[/ol]+
[list=1]: decimal + +
[list=i]: lover case roman + +
[list=I]: upper case roman + +
[list=a]: lover case alphabetic + +
[list=A]: upper case alphabetic + + + + +Embed +------ + +You can embed video, audio and more in a message. + +
[video]url[/video]+
[audio]url[/audio]+ +Where *url* can be an url to youtube, vimeo, soundcloud, or other sites wich supports oembed or opengraph specifications. +*url* can be also full url to an ogg file. HTML5 tag will be used to show it. + +
[url]*url*[/url]+ +If *url* supports oembed or opengraph specifications the embedded object will be shown (eg, documents from scribd). +Page title with a link to *url* will be shown. + +Map +--- + +
[map]address[/map]+
[map=lat,long]+ +You can embed maps from coordinates or addresses. +This require "openstreetmap" addon version 1.3 or newer. + + +Special +------- + +If you need to put literal bbcode in a message, [noparse], [nobb] or [pre] are used to escape bbcode: + +
[noparse][b]bold[/b][/noparse]: [b]bold[/b] + + diff --git a/doc/Home.md b/doc/Home.md index dd63f1095..ff991e3d2 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -11,6 +11,7 @@ Friendica Documentation and Resources * [Comment, sort and delete posts](help/Text_comment) * [Profiles](help/Profiles) * [Accesskey reference](help/Accesskeys + * [Events](help/events) * You and other users * [Connectors](help/Connectors) * [Making Friends](help/Making-Friends) @@ -41,6 +42,7 @@ Friendica Documentation and Resources * [How to translate Friendica](help/translations) * [Bugs and Issues](help/Bugs-and-Issues) * [Plugin Development](help/Plugins) +* [Theme Development](help/themes) * [Smarty 3 Templates](help/smarty3-templates) **External Resources** diff --git a/doc/de/BBCode.md b/doc/de/BBCode.md index dc8bf85d5..d3e205f0f 100644 --- a/doc/de/BBCode.md +++ b/doc/de/BBCode.md @@ -1,139 +1,155 @@ Referenz der Friendica BBCode Tags -======================== - -* [Zur Startseite der Hilfe](help) - -Inline Tags ------ - - +======================== + +* [Zur Startseite der Hilfe](help) + +Inline Tags +----- + +
[b]fett[/b]: fett - +
[i]kursiv[/i]: kursiv - +
[u]unterstrichen[/u]: unterstrichen - +
[s]durchgestrichen[/s]:
[color=red]rot[/color]: rot - +
[url=http://www.friendica.com]Friendica[/url]: Friendica - +
[img]http://friendica.com/sites/default/files/friendika-32.png[/img]: - +
[size=xx-small]kleiner Text[/size]: kleiner Text - +
[size=xx-large]groß Text[/size]: großer Text - +
[size=20]exakte Textgröße[/size] (Textgröße kann jede Zahl sein, in Pixeln): exakte Größe - - - - - - - -Block Tags ------ - -
[code]Code[/code]- -
Code
-
-- -
[quote]Zitat[/quote]- -
Zitat- -
- -
[quote=Autor]Der Autor? Ich? Nein, nein, nein...[/quote]- -Autor hat geschrieben:
Der Autor? Ich? Nein, nein, nein...- -
- -
[center]zentrierter Text[/center]- -
- -**Tabelle** -
[table border=1] - [tr] - [th]Tabellenzeile[/th] - [/tr] - [tr] - [td]haben Überschriften[/td] - [/tr] -[/table]- -
Tabellenzeile |
---|
haben Überschriften |
- -**Listen** - -
[list] - [*] Erstes Listenelement - [*] Zweites Listenelement -[/list]-
[ol] - [*] Erstes Listenelement - [*] Zweites Listenelement -[/ol]-
[list=1]: dezimal - -
[list=i]: römisch, Kleinbuchstaben - -
[list=I]: römisch, Großbuchstaben - -
[list=a]: alphabetisch, Kleinbuchstaben - -
[list=A]: alphabethisch, Großbuchstaben - - - - -Einbettung von Inhalten ------- - -Man kann viele Dinge, z.B. Video und Audio Dateine, in Nachrichten einbetten. - -
[video]url[/video]-
[audio]url[/audio]- -Wobei die *url* von youtube, vimeo, soundcloud oder einer anderen Seite stammen kann die die oembed oder opengraph Spezifikationen unterstützt. + + + + + + + +Block Tags +----- + +
[code]Code[/code]+ +
Code
+
++ +
[quote]Zitat[/quote]+ +
Zitat+ +
+ +
[quote=Autor]Der Autor? Ich? Nein, nein, nein...[/quote]+ +Autor hat geschrieben:
Der Autor? Ich? Nein, nein, nein...+ +
+ +
[center]zentrierter Text[/center]+ +
+ +
Wer überrascht werden möchte sollte nicht weiter lesen.[spoiler]Es gibt ein Happy End.[/spoiler]+ +Wer überrascht werden möchte sollte nicht weiter lesen.
+ +**Tabelle** +
[table border=1] + [tr] + [th]Tabellenzeile[/th] + [/tr] + [tr] + [td]haben Überschriften[/td] + [/tr] +[/table]+ +
Tabellenzeile |
---|
haben Überschriften |
+ +**Listen** + +
[list] + [*] Erstes Listenelement + [*] Zweites Listenelement +[/list]+
[ol] + [*] Erstes Listenelement + [*] Zweites Listenelement +[/ol]+
[list=1]: dezimal + +
[list=i]: römisch, Kleinbuchstaben + +
[list=I]: römisch, Großbuchstaben + +
[list=a]: alphabetisch, Kleinbuchstaben + +
[list=A]: alphabethisch, Großbuchstaben + + + + +Einbettung von Inhalten +------ + +Man kann viele Dinge, z.B. Video und Audio Dateine, in Nachrichten einbetten. + +
[video]url[/video]+
[audio]url[/audio]+ +Wobei die *url* von youtube, vimeo, soundcloud oder einer anderen Seite stammen kann die die oembed oder opengraph Spezifikationen unterstützt. Außerdem kann *url* die genaue url zu einer ogg Datei sein, die dann per HTML5 eingebunden wird. - -
[url]*url*[/url]- + +
[url]*url*[/url]+ Wenn *url* entweder oembed oder opengraph unterstützt wird das eingebettete Objekt (z.B. ein Dokument von scribd) eingebunden. Der Titel der Seite mit einem Link zur *url* wird ebenfalls angezeigt. - - - -Spezielle Tags -------- - + +Um eine Karte in einen Beitrag einzubinden, muss das *openstreetmap* Addon aktiviert werden. Ist dies der Fall, kann mit + +
[map]Broadway 26, New York[/map]+ +eine Karte von [OpenStreetmap](http://openstreetmap.org) eingebettet werden. Zur Identifikation des Ortes können entweder seine Koordinaten in der Form + +
[map=lat,long]+ +oder eine Adresse in obiger Form verwendet werden. + +Spezielle Tags +------- + Wenn Du über BBCode Tags in einer Nachricht schreiben möchtest, kannst Du [noparse], [nobb] oder [pre] verwenden um den BBCode Tags vor der Evaluierung zu schützen: - -
[noparse][b]fett[/b][/noparse]: [b]fett[/b] - - + +
[noparse][b]fett[/b][/noparse]: [b]fett[/b] + + diff --git a/doc/de/Home.md b/doc/de/Home.md index 64982c392..561809d6c 100644 --- a/doc/de/Home.md +++ b/doc/de/Home.md @@ -11,6 +11,7 @@ Friendica - Dokumentation und Ressourcen * [Beiträge kommentieren, einordnen und löschen](help/Text_comment) * [Profile](help/Profiles) * [Referenz der Accesskeys](help/Accesskeys) + * [Veranstaltungen](help/events) (EN) * Du und andere Nutzer * [Konnektoren (Connectors)](help/Connectors) * [Freunde finden](help/Making-Friends) @@ -37,6 +38,16 @@ Friendica - Dokumentation und Ressourcen * [Twitter/GNU Social API Functions](help/api) (EN) * [Translation of Friendica](help/translations) (EN) +**Entwickler Dokumentation** + +* [Where to get started?](help/Developers-Intro) +* [Help on Github](help/Github) +* [Help on Vagrant](help/Vagrant) +* [How to translate Friendica](help/translations) +* [Bugs and Issues](help/Bugs-and-Issues) +* [Plugin Development](help/Plugins) +* [Theme Development](help/themes) +* [Smarty 3 Templates](help/smarty3-templates) **Externe Ressourcen** diff --git a/doc/events.md b/doc/events.md new file mode 100644 index 000000000..abb457687 --- /dev/null +++ b/doc/events.md @@ -0,0 +1,61 @@ +# Events + +* [Home](help) + +A special form of postings are events. +The events you and your contacts share can be found at [/events](/events) on your node. +To get there go to your wall and follow the tab "events" +Depending on the theme you are using, there might be an additional link from the navigation menu to this page. + +## Event Overview + +The overview page shows the calendar of the current month, plus eventually some days in the beginning and the end. +Listed are all events for this month you created, or your contacts have shared with you. +This includes birthday reminders for contacts who share their birthday with you. + +From the controls, you can switch between month/week/day view. +Flip through the view forwards and backwards. +And return to *today*. + +To create a new event, you can either follow the link "Create New Event" or make a double click on the desired box in the calendarium for when the event should take place. + +With a click on an existing event a pop-up box will be opened which shows you the event. +From there you can edit the event or view the event at the source link, if you are the one who created the event. + +## Create a new Event + +Following one of the methods mentioned above you reach a form to enter the event data. +Fields marked with a *** have to be filled. + +* **Event Starts**: enter the date/time of the start of the event here +* **Event Finishes**: enter the finishing date/time for the event here + +When you click in one of these fields a pop-up will be opened that allows you to pick the day and the time. +If you double clicked on the day box in the calendarium these fields will be pre-filled for you. +The finishing date/time has to be after the beginning date/time of the event. +But you don't have to specify it. +If the event is open-end or the finishing date/time does not matter, just select the box below the two first fields. + +* **Adjust for viewer timezone**: If you check this box, the beginning and finisching times will automatically converted to the local time according to the timezone setting + +This might prevent too early birthday wishes, or the panic attac that you have forgotten the birthday from your buddy at the other end of the world. +And similar events. + +* **Title**: a title for the event +* **Description**: a longer description for the event +* **Location**: the location the event will took place + +These three fields describe your events. +In the descirption and location field you can use BBCode to format the text. + +* **Share this event**: when this box is checked the ACL will be shown to let you select with whom you wish to share the event. This works just like the controls of any other posting. + +When you *Share* the event it will be posted to your wall with the access permissions you've selected. +But before you do, you can also *preview* the event in a pop-up box. + +### Addons + +#### OpenStreetMap + +If this addon is activated on you friendica node, the content of the location field will be mathced with the identification service of OSM when you submit the event. +Should OSM find anything matching, a map for the location will be embedded automatically at the end of the events view. diff --git a/doc/themes.md b/doc/themes.md new file mode 100644 index 000000000..add44c776 --- /dev/null +++ b/doc/themes.md @@ -0,0 +1,291 @@ +# Themes + +* [Home](help) + +To change the look of friendica you have to touch the themes. +The current default theme is [duepunto zero](https://github.com/friendica/friendica/tree/master/view/theme/duepuntozero) but there are numerous others. +Have a look at [friendica-themes.com](http://friendica-themes.com) for an overview of the existing themes. +In case none of them suits your needs, there are several ways to change a theme. +If you need help theming, there is a forum @[ftdevs@friendica.eu](https://friendica.eu/profile/ftdevs) where you can ask theme specific questions and present your themes. + +So, how to work on the UI of friendica. + +You can either directly edit an existing theme. +But you might loose your changes when the theme is updated by the friendica team. + +If you are almost happy with an existing theme, the easiest way to cover your needs is to create a new theme, inheritating most of the properties of the parent theme and change just minor stuff. +The below for a more detailed description of theme heritage. + +Some themes also allow users to select *variants* of the theme. +Those theme variants most often contain an additional [CSS](https://en.wikipedia.org/wiki/CSS) file to override some styling of the default theme values. +From the themes in the main repository *duepunto zero* and *vier* are using this methods for variations. +Quattro is using a slightly different approach. + +Third you can start your theme from scratch. +Which is the most complex way to change friendicas look. +But it leaves you the most freedom. +So below for a *detailed* description and the meaning of some special files. + +### Styling + +If you want to change the styling of a theme, have a look at the themes CSS file. +In most cases, you can found these in + + /view/theme/**your-theme-name**/style.css + +sometimes, there is also a file called style.php in the theme directory. +This is only needed if the theme allowes the user to change certain things of the theme dynamically. +Say the font size or set a background image. + +### Templates + +If you want to change the structure of the theme, you need to change the templates used by the theme. +Friendica themes are using [SMARTY3](http://www.smarty.net/) for templating. +The default template can be found in + + /view/templates + +if you want to override any template within your theme create your version of the template in + + /view/theme/**your-theme-name**/templates + +any template that exists there will be used instead of the default one. + +### Javascript + +The same rule applies to the JavaScript files found in + + /js + +they will be overwritten by files in + + /view/theme/**your-theme-name**/js. + +## Expand an existing Theme + +### Theme Variations + +Many themes are more *theme families* then only one theme. +*duepunto zero* and *vier* allow easily to add new theme variation. +We will go through the process of creating a new variation for *duepunto zero*. +The same (well almost, some names change) procedure applies to the *vier* theme. +And similar steps are needed for *quattro* but this theme is using [lessc](http://lesscss.org/#docs) to maintaine the CSS files.. + +In + + /view/theme/duepuntozero/deriv + +you find a couple of CSS files that define color derivations from the duepunto theme. +These resemble some of the now as unsupported marked themes, that were inherited by the duepunto theme. +Darkzero and Easter Bunny for example. + +The selection of the colorset is done in a combination of a template for a new form in the settings and aome functions in the theme.php file. +The template (theme_settings.tpl) + + {{include file="field_select.tpl" field=$colorset}} +