From: Fabrixxm Date: Wed, 24 Apr 2013 11:59:06 +0000 (-0400) Subject: doc update X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=92c7ec6c8bdb86f37f500b6c1e10ddc660b4fe54;p=friendica.git doc update add BBCode reference update 'Creating posts', change screenshot (use duepuntozero theme) update 'Install', add point on create view/smarty3 folder update 'Plugins', add section on templates --- diff --git a/doc/BBCode.md b/doc/BBCode.md new file mode 100644 index 0000000000..c84308e5b7 --- /dev/null +++ b/doc/BBCode.md @@ -0,0 +1,138 @@ +Friendica BBCode tags reference +======================== + +* [Home](help) + +Inline +----- + + +
[b]bold[/b]
: bold + +
[i]italic[/i]
: italic + +
[u]underlined[/u]
: underlined + +
[s]strike[/s]
: strike + +
[color=red]red[/color]
: red + +
[url=http://www.friendica.com]Friendica[/url]
: Friendica + +
[img]http://friendica.com/sites/default/files/friendika-32.png[/img]
: Immagine/foto + +
[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]
+ +
centered text
+ +

 

+ +**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]
+ + +[list] is equivalent to [ul] (unordered list). + +[ol] can be used instead of [list] to show an ordered list: + +
[ol]
+ [*] First list element
+ [*] Second list element
+[/ol]
+ + +For more options on ordered lists, you can define the style of numeration on [list] argument: +
[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. + + + +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/Developers.md b/doc/Developers.md index 17aff38697..b0fce47b52 100644 --- a/doc/Developers.md +++ b/doc/Developers.md @@ -1,6 +1,7 @@ Friendica Developer Guide +=================== -Here is how you can join us. +**Here is how you can join us.** First, get yourself a working git package on the system where you will be doing development. diff --git a/doc/Home.md b/doc/Home.md index e986c89ac9..3f2c51bebf 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -7,6 +7,7 @@ Friendica Documentation and Resources * [Account Basics](help/Account-Basics) * [New User Quick Start](help/Quick-Start-guide) * [Creating posts](help/Text_editor) + * [BBCode tag reference](help/BBCode) * [Comment, sort and delete posts](help/Text_comment) * [Profiles](help/Profiles) * You and other user diff --git a/doc/Install.md b/doc/Install.md index 9455c62ba2..7f9330752e 100644 --- a/doc/Install.md +++ b/doc/Install.md @@ -1,4 +1,5 @@ Friendica Installation +=============== We've tried very hard to ensure that Friendica will run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites. But be aware that Friendica is more than a simple web application. It is a complex communications system which more closely resembles an email server than a web server. For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down. This kind of functionality requires a bit more of the host system than the typical blog. Not every PHP/MySQL hosting provider will be able to support Friendica. Many will. But **please** review the requirements and confirm these with your hosting provider prior to installation. @@ -41,6 +42,12 @@ you might have trouble getting everything to work.] - and then you can pick up the latest changes at any time with `git pull` + + - make sure folder *view/smarty3* exists and is writable by webserver + + `mkdir view/smarty3` + + `chown 777 view/smarty3` - For installing addons diff --git a/doc/Plugins.md b/doc/Plugins.md index df60044500..2ae942eae5 100644 --- a/doc/Plugins.md +++ b/doc/Plugins.md @@ -1,4 +1,5 @@ -**Friendica Addon/Plugin development** +Friendica Addon/Plugin development +========================== Please see the sample addon 'randplace' for a working example of using some of these features. The facebook addon provides an example of integrating both "addon" and "module" functionality. Addons work by intercepting event hooks - which must be registered. Modules work by intercepting specific page requests (by URL path). @@ -51,7 +52,8 @@ currently being processed, and generally contains information that is being imme processed or acted on that you can use, display, or alter. Remember to declare it with '&' if you wish to alter it. -**Modules** +Modules +-------- Plugins/addons may also act as "modules" and intercept all page requests for a given URL path. In order for a plugin to act as a module it needs to define a function "plugin_name_module()" which takes no arguments and need not do anything. @@ -62,8 +64,29 @@ If this function exists, you will now receive all page requests for "http://my.w Your module functions will often contain the function plugin_name_content(&$a), which defines and returns the page body content. They may also contain plugin_name_post(&$a) which is called before the _content function and typically handles the results of POST forms. You may also have plugin_name_init(&$a) which is called very early on and often does module initialisation. +Templates +---------- -**Current hooks:** +If your plugin need some template, you can use Friendica template system. Friendica use [smarty3](http://www.smarty.net/) as template engine. + +Put your tpl files in *templates/* subfolder of your plugin. + +In your code, like in function plugin_name_content(), load template file and execute it passing needed values: + + # load template file. first argument is the template name, + # second is the plugin path relative to friendica top folder + $tpl = get_markup_template('mytemplate.tpl', 'addon/plugin_name/'); + + # apply template. first argument is the loaded template, + # second an array of 'name'=>'values' to pass to template + $output = replace_macros($tpl,array( + 'title' => 'My beautifull plugin', + )); + +See also wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide) + +Current hooks: +-------------- **'authenticate'** - called when a user attempts to login. $b is an array diff --git a/doc/Text_editor.md b/doc/Text_editor.md index e2234825a9..aff0ce603b 100644 --- a/doc/Text_editor.md +++ b/doc/Text_editor.md @@ -1,40 +1,110 @@ + + Creating posts -================= +=========== * [Home](help) -Here you can find an overview of the different ways to create and edit your post. Attention: we've used the "diabook" theme. If you're using another theme, some of the icons may be different. +Here you can find an overview of the different ways to create and edit your post. + +One click on "Share" text box on top of your Home or Network page, and the post editor shows up: + +
+default editor +
Default post editor, with default Friendica theme (duepuntozero)
+
+ +Post title is optional, you can set it clicking on "Set title". + +Posts can optionally be in one or more categories. Write categories name separated by a comma to file your new post. -editor +The Big Empty Textarea is where you write your new post. +You can simply enter your text there and click "Share" button, and your new post will be public on your profile page and shared to your contact. -The different icons +If plain text is not so exciting to you, Friendica understands BBCode to spice up your posts: bold, italic, images, links, lists.. +See [BBCode tags reference](help/BBCode) page to see all what you can do. -editor This symbol is used to upload a picture from your computer. If you only want to add an adress (url), you can also use the "tree" icon at the upper part of the editor. After selecting an image, you'll see a thumbnail in the editor. +The icons under the text area are there to help you to write posts quickly: + +editor Upload a picture from your computer. The image will be uploaded and correct bbcode tag will be added to your post.

-paper_clip This symbol is used to add files from your computer. There'll be no preview of the content. +paper_clip Add files from your computer. Same as picture, but for generic attachment to the post.

-chain This symbol is used to add a web address (url). You'll see a short preview of the website. +chain Add a web address (url). Enter an url and Friendica will add to your post a link to the url and an excerpt from the web site, if possible

-video This symbol is used to add a web address (url) of a video file. You'll see a small preview of the video. +video Add a video. Enter the url to a video (ogg) or to a video page on youtube or vimeo, and it will be embedded in your post

-mic This symbol is used to add a web address (url) of an audio file. You'll see a player in your completed post. +mic Add an audio. Same as video, but for audio

-globe This symbol is used to add your geographic location. This location will be added into a Google Maps search. That's why a note like "New York" or "10004" is already enough. +globe Set your geographic location. This location will be added into a Google Maps search. That's why a note like "New York" or "10004" is already enough.

-**Symbols of other themes** +Those icons can change with themes. Some examples: + + + + + + + + + + + + + + + + + +
Darkbubble: darkbubble.png(inkl. smoothly, testbubble)
Frost: frost.png  
Vier: vier.png(inkl. dispy)
+

 

+

 

+ +**lock icon The lock** + +The last button, the Lock, is the most important feature in Friendica. If the lock is open, your post will be public, and will shows up on your profile page when strangers visit it. + +Click on it and the *Permission settings* window (aka "*Access Control Selector*" or "*ACL Selector*") pops up. There you can select who can see the post. + +
+Permission settings window +
Permission settings window with some contact selected
+
+ +Click on "show" under contact name to hide the post to everyone but selected. + +Click on "Visible to everybody" to make the post public again. + +If you have defined some groups, you can check "show" for groups also. All contact in that group will see the post. +If you want to hide the post to one contact of a group selected for "show", click "don't show" under contact name. + +Click again on "show" or "don't show" to switch it off. + +You can search for contacts or groups with the search box. + +See also [Group and Privacy](help/Groups-and-Privacy) + + -Cleanzero cleanzero.png +WYSIAWYG (What You See Is About What You Get) +-------------------------------------------------- -(incl. more "zero"-themes, comix, easterbunny, facepark, slackr +Friendica can use TinyMCE as rich text editor. This way you can write beatifull post without the need to know [BBCode](help/BBCode). -Darkbubble darkbubble.png (inkl. smoothly, testbubble) +By default, rich editor is disabled. You can enable it from Settings -> [Aditional features](settings/features) page, turn on Richtext Editor and click "Submit". -Frost frost.png +
+default editor +
Rich editor, with default Friendica theme (duepuntozero)
+
-Vier vier.png (inkl. dispy) diff --git a/doc/img/acl_win.png b/doc/img/acl_win.png new file mode 100644 index 0000000000..00ad766992 Binary files /dev/null and b/doc/img/acl_win.png differ diff --git a/doc/img/camera.png b/doc/img/camera.png index af73b0d73f..1f8a92c349 100644 Binary files a/doc/img/camera.png and b/doc/img/camera.png differ diff --git a/doc/img/chain.png b/doc/img/chain.png index c8f8bf1f34..6537c07d42 100644 Binary files a/doc/img/chain.png and b/doc/img/chain.png differ diff --git a/doc/img/friendica_editor.png b/doc/img/friendica_editor.png index 397c4b5958..aebcf111b2 100644 Binary files a/doc/img/friendica_editor.png and b/doc/img/friendica_editor.png differ diff --git a/doc/img/friendica_rich_editor.png b/doc/img/friendica_rich_editor.png new file mode 100644 index 0000000000..4cd8beac99 Binary files /dev/null and b/doc/img/friendica_rich_editor.png differ diff --git a/doc/img/globe.png b/doc/img/globe.png index b8a319db09..ec1b7ff4ae 100644 Binary files a/doc/img/globe.png and b/doc/img/globe.png differ diff --git a/doc/img/lock.png b/doc/img/lock.png new file mode 100644 index 0000000000..b9a1cefc5c Binary files /dev/null and b/doc/img/lock.png differ diff --git a/doc/img/mic.png b/doc/img/mic.png index 616e798592..c8d4c0e382 100644 Binary files a/doc/img/mic.png and b/doc/img/mic.png differ diff --git a/doc/img/paper_clip.png b/doc/img/paper_clip.png index 1d9cc0a092..51c7cdf704 100644 Binary files a/doc/img/paper_clip.png and b/doc/img/paper_clip.png differ diff --git a/doc/img/video.png b/doc/img/video.png index be023d746d..00561f1b3e 100644 Binary files a/doc/img/video.png and b/doc/img/video.png differ