From 86c4ac80c5dc0356f1e51ca40cdb558064467ac1 Mon Sep 17 00:00:00 2001 From: Thomas Willingham Date: Fri, 19 May 2017 21:37:45 +0100 Subject: [PATCH 1/2] Update doco --- doc/Account-Basics.md | 4 +-- doc/BBCode.md | 48 ++++++++++++++-------------- doc/Bugs-and-Issues.md | 8 ++--- doc/Chats.md | 10 +++--- doc/FAQ.md | 4 +-- doc/Forums.md | 2 +- doc/Making-Friends.md | 2 +- doc/Settings.md | 4 +-- doc/andfinally.md | 22 ------------- doc/api.md | 69 ++++++++++++++++++++-------------------- doc/events.md | 20 ++++++------ doc/groupsandpages.md | 11 ------- doc/guide.md | 13 -------- doc/htconfig.md | 7 ++-- doc/makingnewfriends.md | 11 ------- doc/network.md | 14 -------- doc/smarty3-templates.md | 2 +- doc/themes.md | 18 +++++------ doc/translations.md | 4 +-- 19 files changed, 101 insertions(+), 172 deletions(-) delete mode 100644 doc/andfinally.md delete mode 100644 doc/groupsandpages.md delete mode 100644 doc/guide.md delete mode 100644 doc/makingnewfriends.md delete mode 100644 doc/network.md diff --git a/doc/Account-Basics.md b/doc/Account-Basics.md index ef6a13f22..854e78b14 100644 --- a/doc/Account-Basics.md +++ b/doc/Account-Basics.md @@ -10,10 +10,10 @@ Not all Friendica sites allow open registration. If registration is allowed, you will see a "Register" link immediately below the login prompt on the site home page. Following this link will take you to the site registration page. The strength of our network is that lots of different sites are all completely compatible with each other. -If the site you're visting doesn't allow registration, or you think you might prefer another one, you can find a [list of public servers here](http://dir.friendica.com/siteinfo), and find one that meets your needs. +If the site you're visting doesn't allow registration, or you think you might prefer another one, you can find a [list of public servers here](https://dir.friendica.social/servers), and find one that meets your needs. If you'd like to have your own server, you can do that too. -Visit [the Friendica website](http://friendica.com/download) to download the code with setup instructions. +Visit [the Friendica website](http://friendi.ca/) to download the code with setup instructions. It's a very simple installation process that anybody experienced in hosting websites, or with basic Linux experience can handle easily. ###OpenID diff --git a/doc/BBCode.md b/doc/BBCode.md index 50fb406b0..b4b7faf64 100644 --- a/doc/BBCode.md +++ b/doc/BBCode.md @@ -61,17 +61,17 @@ table.bbcodes > * > tr > th { red - [url=http://www.friendica.com]Friendica[/url] - Friendica + [url=http://friendi.ca]Friendica[/url] + Friendica - [img]http://friendica.com/sites/default/files/friendika-32.png[/img] - Immagine/foto + [img]https://raw.githubusercontent.com/friendica/friendica/develop/images/friendica-32.jpg[/img] + Immagine/foto - [img=64x32]http://friendica.com/sites/default/files/friendika-32.png[/img]
+ [img=64x32]https://raw.githubusercontent.com/friendica/friendica/develop/images/friendica-32.jpg[/img]

Note: provided height is simply discarded. - + [size=xx-small]small text[/size] @@ -82,7 +82,7 @@ table.bbcodes > * > tr > th { big text - [size=20]exact size[/size] (size can be any number, in pixel) + [size=20]exact size[/size] (size can be any number, in pixels) exact size @@ -99,23 +99,23 @@ table.bbcodes > * > tr > th { Result - [url]http://friendica.com[/url] - http://friendica.com + [url]http://friendi.ca[/url] + http://friendi.ca - [url=http://friendica.com]Friendica[/url] - Friendica + [url=http://friendi.ca]Friendica[/url] + Friendica - [bookmark]http://friendica.com[/bookmark]

-#^[url]http://friendica.com[/url] -

Friendica: http://friendica.com

 + [bookmark]http://friendi.ca[/bookmark]

+#^[url]http://friendi.ca[/url] +

Friendica: http://friendi.ca

 - [bookmark=http://friendica.com]Bookmark[/bookmark]

-#^[url=http://friendica.com]Bookmark[/url]

-#[url=http://friendica.com]^[/url][url=http://friendica.com]Bookmark[/url] -

Friendica: Bookmark

 + [bookmark=http://friendi.ca]Bookmark[/bookmark]

+#^[url=http://friendi.ca]Bookmark[/url]

+#[url=http://friendi.ca]^[/url][url=http://friendi.ca]Bookmark[/url] +

Friendica: Bookmark

 [url=/posts/f16d77b0630f0134740c0cc47a0ea02a]Diaspora post with GUID[/url] @@ -490,7 +490,7 @@ Page title with a link to *url* will be shown. ## Map -This require "openstreetmap" or "Google Maps" addon version 1.3 or newer. +This requires "openstreetmap" or "Google Maps" addon version 1.3 or newer. If the addon isn't activated, the raw coordinates are shown instead. @@ -514,10 +514,10 @@ If the addon isn't activated, the raw coordinates are shown instead. ## 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 a length limitation like on Twitter. +If you want to spread your post to several third party networks you may have the problem that these networks have 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 a custom abstract that will only be displayed on the external network. +Friendica uses a semi-intelligent mechanism to generate a fitting abstract. +But it can be useful to define a custom abstract that will only be displayed on the external network. This is done with the [abstract]-element.
@@ -566,7 +566,7 @@ Instead you have to name the explicit network:
[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=goog]Hello 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...		 Google and Facebook will show the respective abstracts while the other networks will show the default one.
@@ -574,7 +574,7 @@ While taking pictures in the woods I had a really strange encounter...
-The [abstract] element isn't working with connectors where we post the HTML like Tumblr, Wordpress or Pump.io. +The [abstract] element is not working with connectors where we post HTML directly, like Tumblr, Wordpress or Pump.io. For the native connections--that is to e.g. Friendica, Hubzilla, Diaspora or GNU Social--the full posting is used and the contacts instance will display the posting as desired. ## Special diff --git a/doc/Bugs-and-Issues.md b/doc/Bugs-and-Issues.md index d316971d2..e2665be41 100644 --- a/doc/Bugs-and-Issues.md +++ b/doc/Bugs-and-Issues.md @@ -5,9 +5,9 @@ Bugs and Issues If your server has a support page, you should report any bugs/issues you encounter there first. Reporting to your support page before reporting to the developers makes their job easier, as they don't have to deal with bug reports that might not have anything to do with them. -This helps us get new features faster. +Reducing the workload in this way helps us get new features faster. You can also contact the [friendica support forum](https://helpers.pyxis.uberspace.de/profile/helpers) and report your problem there. -Maybe someone from another node encountered the problem as well and can help you. +Bugs are rarely limited to one person, and the chances are somebody from another node has encountered the problem too, and will be able to help you. If you're a technical user, or your site doesn't have a support page, you'll need to use the [Bug Tracker](https://github.com/friendica/friendica/issues). Please perform a search to see if there's already an open bug that matches yours before submitting anything. @@ -15,6 +15,6 @@ Please perform a search to see if there's already an open bug that matches yours Try to provide as much information as you can about the bug, including the **full** text of any error messages or notices, and any steps required to replicate the problem in as much detail as possible. It's generally better to provide too much information than not enough. -See [this article](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) to learn more about submitting **good** bug reports. +See [this article](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) to learn more about submitting **good** bug reports. The better your bug report, the more likely we are to be able to actually fix it. -And last but not least: Better report an issue you encountered even if you don't write the perfect bug report! +And last but not least: It is better to report an issue you encountered even if you can't write the perfect bug report! \ No newline at end of file diff --git a/doc/Chats.md b/doc/Chats.md index 3698ad15d..4e392f8d8 100644 --- a/doc/Chats.md +++ b/doc/Chats.md @@ -3,7 +3,7 @@ Chats * [Home](help) -There are two possibilities to use a chat on your friendica site +There are two possibilities to use chat on your friendica site * IRC Chat * Jappix @@ -14,13 +14,13 @@ IRC-Chat Plugin After activating the plugin, you can find the chat at [yoursite.com/irc](../irc). Note: you can use this chat without any login at your site so that everyone could use it. -If you follow the link, you will see the login page of the IR chat. +If you follow the link, you will see the login page of the IRC chat. Now choose a nickname and a chatroom. -You can choose every name for the room, even something like #superchatwhosenameisonlyknownbyme. -At last, solve the captchas and click the connect button. +You can choose any name you like for the room, even something like #superchatwhosenameisonlyknownbyme. +Finally, solve the captchas and click the connect button. The following window shows some text while connecting. -This text isn't importend for you, just wait for the next window. +This text isn't important, just wait for the next window. The first line shows your name and your current IP address. The right part of the window shows all users. The lower part of the window contains an input field. diff --git a/doc/FAQ.md b/doc/FAQ.md index 36fe1a8b4..da58e09f7 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -176,7 +176,7 @@ Depending on the features of the client you might encounter some glitches in usa ###Where I can find help? If you have problems with your Friendica page, you can ask the community at the [Friendica Support Group](https://helpers.pyxis.uberspace.de/profile/helpers). -If you can't use your default profile you can either use a test account [test server](http://friendica.com/node/31) respectively an account at a public site [list](http://dir.friendica.com/siteinfo) or you can use the Librelist mailing list. +If you can't use your default profile you can use an account at a public site [list](https://dir.friendica.social/servers) or you can use the Librelist mailing list. If you want to use the mailing list, please just send a mail to friendica AT librelist DOT com. If you are a theme developer, you will find help at this forum: [Friendica Theme Developers](https://friendica.eu/profile/ftdevs). @@ -188,7 +188,7 @@ Admin ###Can I configure multiple domains with the same code instance? -No, this function is no longer supported from Friendica 3.3 onwards. +No, this function is no longer supported as of Friendica 3.3 onwards. diff --git a/doc/Forums.md b/doc/Forums.md index 54e8e3879..78a3e193e 100644 --- a/doc/Forums.md +++ b/doc/Forums.md @@ -22,7 +22,7 @@ This is the default selection. Community Forum/Celebrity Accounts provide the ability for people to become friends/fans of the forum without requiring approval. The exact setting you would use depends on how you wish to interact with people who join the page. -The "Soapbox" setting let's the page owner control all communications. +The "Soapbox" setting lets the page owner control all communications. Everything you post will go out to the forum members, but there will be no opportunity for interaction. This setting would typically be used for announcements or corporate communications. diff --git a/doc/Making-Friends.md b/doc/Making-Friends.md index 8f2985463..448f125d7 100644 --- a/doc/Making-Friends.md +++ b/doc/Making-Friends.md @@ -9,7 +9,7 @@ How do you do it? The Directories --- -Friendica has two different kinds of "addressbook": +Friendica has two different kinds of "address book": The directory of the Friendica server you are registered on and the global directory that collects account information across all Friendica instances. The first thing you can do is look at the **Directory**. diff --git a/doc/Settings.md b/doc/Settings.md index e84418a45..a1c5f5621 100644 --- a/doc/Settings.md +++ b/doc/Settings.md @@ -130,7 +130,7 @@ By default, any (valid) email address is allowed in registrations. #### Allow Users to set remote_self -If you enable the `Allow Users to set remote_self` users can select Atom feeds from their contact list being their *remote self* in die advanced contact settings. +If you enable the `Allow Users to set remote_self` users can select Atom feeds from their contact list being their *remote self* in the advanced contact settings. Which means that postings by the remote self are automatically reposted by Friendica in their names. This feature can be used to let the user mirror e.g. blog postings into their Friendica postings. @@ -212,7 +212,7 @@ To simplify this process there is a button at the top of the page to reload all ## Themes The Themes section of the admin panel works similar to the Plugins section but let you control the themes on your Friendica node. -Each theme has a dedicated suppage showing the current status, some information about the theme and a screen-shot of the Friendica interface using the theme. +Each theme has a dedicated subpage showing the current status, some information about the theme and a screen-shot of the Friendica interface using the theme. Should the theme offer special settings, admins can set a global default value here. You can activate and deactivate themes on their dedicated sub-pages thus making them available for the users of the node. diff --git a/doc/andfinally.md b/doc/andfinally.md deleted file mode 100644 index f7aeb1bd4..000000000 --- a/doc/andfinally.md +++ /dev/null @@ -1,22 +0,0 @@ -[[!meta title="And Finally..."]] - -And that brings the Quick Start to an end. - -Here are some more things to help get you started: - -**Groups** - - -- Friendica Support - problems? This is the place to ask. - -- Let's Talk a group for finding people and groups who share similar interests. - -- Local Friendica a page for local Friendica groups - - -**Documentation** - -- Connecting to more networks -- Help Index - - diff --git a/doc/api.md b/doc/api.md index 04abaa563..222ac89e6 100644 --- a/doc/api.md +++ b/doc/api.md @@ -3,7 +3,7 @@ Friendica API * [Home](help) -The Friendica API aims to be compatible to the [GNU Social API](http://wiki.gnusocial.de/gnusocial:api) and the [Twitter API](https://dev.twitter.com/rest/public). +The Friendica API aims to be compatible with the [GNU Social API](http://wiki.gnusocial.de/gnusocial:api) and the [Twitter API](https://dev.twitter.com/rest/public). Please refer to the linked documentation for further information. @@ -43,13 +43,13 @@ In this document, endpoints which requires auth are marked with "AUTH" after end * network: network of the user #### Errors -When an error occour in API call, an HTTP error code is returned, with an error message +When an error occurs in API call, an HTTP error code is returned, with an error message Usually: -- 400 Bad Request: if parameter are missing or items can't be found -- 403 Forbidden: if authenticated user is missing -- 405 Method Not Allowed: if API was called with invalid method, eg. GET when API require POST -- 501 Not Implemented: if requested API doesn't exists -- 500 Internal Server Error: on other error contitions +- 400 Bad Request: if parameters are missing or items can't be found +- 403 Forbidden: if the authenticated user is missing +- 405 Method Not Allowed: if API was called with an invalid method, eg. GET when API require POST +- 501 Not Implemented: if the requested API doesn't exist +- 500 Internal Server Error: on other error conditions Error body is @@ -89,7 +89,7 @@ Unofficial Twitter command. It shows all direct answers (excluding the original * id: id of the post * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * include_entities: "true" shows entities for pictures and links (Default: false) @@ -103,7 +103,7 @@ Unofficial Twitter command. It shows all direct answers (excluding the original #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * getText: Defines the format of the status field. Can be "html" or "plain" * include_entities: "true" shows entities for pictures and links (Default: false) @@ -117,7 +117,7 @@ Unofficial Twitter command. It shows all direct answers (excluding the original #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * getText: Defines the format of the status field. Can be "html" or "plain" * friendica_verbose: "true" enables different error returns (default: "false") @@ -128,7 +128,7 @@ Shows all direct messages of a conversation #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * getText: Defines the format of the status field. Can be "html" or "plain" * uri: URI of the conversation @@ -139,7 +139,7 @@ Shows all direct messages of a conversation #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * getText: Defines the format of the status field. Can be "html" or "plain" * include_entities: "true" shows entities for pictures and links (Default: false) @@ -182,7 +182,7 @@ HTTP 400 BadRequest #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * include_entities: "true" shows entities for pictures and links (Default: false) @@ -208,26 +208,26 @@ Set this values will result in an empty array. --- ### followers/ids (*; AUTH) #### Parameters -* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false) +* stringify_ids: Send id numbers as text (true) or integers (false)? (default: false) #### Unsupported parameters * user_id * screen_name * cursor -Friendica doesn't allow showing followers of other users. +Friendica doesn't allow showing the followers of other users. --- ### friends/ids (*; AUTH) #### Parameters -* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false) +* stringify_ids: Send the id numbers as text (true) or integers (false)? (default: false) #### Unsupported parameters * user_id * screen_name * cursor -Friendica doesn't allow showing friends of other users. +Friendica doesn't allow showing the friends of other users. --- ### help/test (*) @@ -283,7 +283,7 @@ Friendica doesn't allow showing friends of other users. #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * exclude_replies: don't show replies (default: false) * conversation_id: Shows all statuses of a given conversation. @@ -299,7 +299,7 @@ Friendica doesn't allow showing friends of other users. #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * exclude_replies: don't show replies (default: false) * conversation_id: Shows all statuses of a given conversation. @@ -315,7 +315,7 @@ Friendica doesn't allow showing friends of other users. #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * include_entities: "true" shows entities for pictures and links (Default: false) @@ -329,7 +329,7 @@ Friendica doesn't allow showing friends of other users. #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * exclude_replies: don't show replies (default: false) * conversation_id: Shows all statuses of a given conversation. @@ -343,7 +343,7 @@ Friendica doesn't allow showing friends of other users. #### Parameters * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * include_entities: "true" shows entities for pictures and links (Default: false) @@ -403,7 +403,7 @@ Friendica doesn't allow showing friends of other users. * screen_name: screen name (for technical reasons, this value is not unique!) * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * exclude_replies: don't show replies (default: false) * conversation_id: Shows all statuses of a given conversation. @@ -426,7 +426,7 @@ It shows all direct answers (excluding the original post) to a given id. * id: id of the post * count: Items per page (default: 20) * page: page number -* since_id: minimal id +* since_id: minimum id * max_id: maximum id * include_entities: "true" shows entities for pictures and links (Default: false) @@ -640,7 +640,7 @@ If the note is linked to an item, the item is returned, just like one of the "st If the note is not linked to an item, a success status is returned: -* "success" (json) | "<status>success</status>" (xml) +* "success" (json) | success;" (xml) --- @@ -671,8 +671,8 @@ json ``` { "id": "photo id" - "created": "date(YYYY-MM-GG HH:MM:SS)", - "edited": "date(YYYY-MM-GG HH:MM:SS)", + "created": "date(YYYY-MM-DD HH:MM:SS)", + "edited": "date(YYYY-MM-DD HH:MM:SS)", "title": "photo title", "desc": "photo description", "album": "album name", @@ -695,8 +695,8 @@ xml ``` photo id - date(YYYY-MM-GG HH:MM:SS) - date(YYYY-MM-GG HH:MM:SS) + date(YYYY-MM-DD HH:MM:SS) + date(YYYY-MM-DD HH:MM:SS) photo title photo description album name @@ -793,13 +793,13 @@ On error: * album: name of the album to be deleted (always necessary) * album_new (optional): can be used to change the album of a single photo if photo_id is specified * allow_cid/allow_gid/deny_cid/deny_gid (optional): on create: empty string or omitting = public photo, specify in format '``````' for private photo; - on update: keys need to be present with empty values for setting a private photo now to public + on update: keys need to be present with empty values for changing a private photo to public both calls point to one function for creating AND updating photos. Saves data for the scales 0-2 to database (see above for scale description). Call adds non-visible entries to items table to enable authenticated contacts to comment/like the photo. Client should pay attention to the fact that updated access rights are not transferred to the contacts. i.e. public photos remain publicly visible if they have been commented/liked before setting visibility back to a limited group. -Currently it is best way to inform user that updating rights is not the best way, offer a solution to add photo as a new photo with the new rights. +Currently it is best to inform user that updating rights is not the right way to do this, and offer a solution to add photo as a new photo with the new rights instead. #### Return values @@ -884,8 +884,8 @@ On success: Array of: * profiles: array of the profile data On error: -HTTP 403 Forbidden: when no authentication provided -HTTP 400 Bad Request: if given profile_id is not in db or not assigned to authenticated user +HTTP 403 Forbidden: when no authentication was provided +HTTP 400 Bad Request: if given profile_id is not in the database or is not assigned to the authenticated user General description of profile data in API returns: * profile_id @@ -913,7 +913,7 @@ The following API calls are implemented in GNU Social but not in Friendica: (inc * blocks/create * blocks/destroy -The following API calls from the Twitter API aren't implemented neither in Friendica nor in GNU Social: +The following API calls from the Twitter API are not implemented in either Friendica or GNU Social: * statuses/mentions_timeline * statuses/retweets/:id @@ -990,7 +990,6 @@ The following API calls from the Twitter API aren't implemented neither in Frien ## Usage Examples ### BASH / cURL -Betamax has documentated some example API usage from a [bash script](https://en.wikipedia.org/wiki/Bash_(Unix_shell) employing [curl](https://en.wikipedia.org/wiki/CURL) (see [his posting](https://betamax65.de/display/betamax65/43539)). /usr/bin/curl -u USER:PASS https://YOUR.FRIENDICA.TLD/api/statuses/update.xml -d source="some source id" -d status="the status you want to post" diff --git a/doc/events.md b/doc/events.md index 0aca7a902..81252987b 100644 --- a/doc/events.md +++ b/doc/events.md @@ -9,15 +9,15 @@ Depending on the theme you are using, there might be an additional link from the ## 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. +The overview page shows the calendar of the current month, plus a few days days at the beginning and the end. +Listed are all events for this month, created by you, or shared with you by your contacts, 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. +To create a new event, you can either follow the link "Create New Event" or double click on the desired box in the calendar in which 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. @@ -31,14 +31,14 @@ Fields marked with a *** have to be filled. * **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. +If you double clicked on the day box in the calendar 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. +If the event is open-ended 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 +* **Adjust for viewer timezone**: If you check this box, the beginning and finishing 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. +This might prevent early birthday wishes, or the panic that you have forgotten the birthday from your buddy at the other side of the world. And similar events. * **Title**: a title for the event @@ -46,7 +46,7 @@ And similar events. * **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. +In the description 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. @@ -59,13 +59,13 @@ When you publish an event, you can choose who shall receive it, as with a regula The recipients will see the posting about the event in their network-stream. Additionally it will be added to their calendar and thus be shown in their events overview page. -Recipients of the event-posting can comment or dis-/like the event, as with a regular posting, but also announce that they will attend, not attend or may-be attend the event with a single click. +Recipients of the event-posting can comment or dis-/like the event, as with a regular posting, and also announce that they will attend, not attend or may-be attend the event with a single click. ### 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. +If this addon is activated on you friendica node, the content of the location field will be matched 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. #### Calendar Export diff --git a/doc/groupsandpages.md b/doc/groupsandpages.md deleted file mode 100644 index 5cfbc653c..000000000 --- a/doc/groupsandpages.md +++ /dev/null @@ -1,11 +0,0 @@ -This is the global directory. If you get lost, you can click this link to bring yourself back here. - -On this page, you'll find a collection of groups, forums and celebrity pages. Groups are not real people. Connecting to them is similar to "liking" something on Facebook, or signing up for a new forum. You don't have to feel awkward about introducing yourself to a new person, because they're not people! - -When you connect to a group, all messages to that group will start appearing in your network tab. You can comment on these posts, or post to the group yourself without ever having to add any of the groups members. This is a great way to make friends dynamically - you'll find people you like and add each other naturally instead of adding random strangers. Simply find a group you're interested in, and connect to it the same way you did with people in the last section. There are a lot of groups, and you're likely to get lost. Remember the link at the top of this page will bring you back here. - -Once you've added some groups, move on to the next section. - - - - diff --git a/doc/guide.md b/doc/guide.md deleted file mode 100644 index d76af92e2..000000000 --- a/doc/guide.md +++ /dev/null @@ -1,13 +0,0 @@ -First things first, let's make sure you're logged in to your account. If you're not already logged in, do so in the frame below. - -Once you've logged in (or if you are already logged in), you'll now be looking at your profile page. - -This is a bit like your Facebook wall. It's where all your status messgages are kept, and where your friends come to post on your wall. To write your status, simply click in the box that says "share". When you do this, the box will expand. You can see some formatting options at the top such as Bold, Italics and Underline, as well as ways to add links and pictures. At the bottom you'll find some more links. You can use these to upload pictures and files from your computer, share websites with a bit of preview text, or embed video and audio files from elsewhere on the web. You can also set your post location here. - -Once you've finished writing your post, click on the padlock icon to select who can see it. If you do not use the padlock icon, your post will be public. This means it will appear to anybody who views your profile, and in the community tab if your site has it enabled, as well as in the network tab of any of your contacts. - -Play around with this a bit, then when you're ready to move on, we'll take a look at the Network Tab - - - - diff --git a/doc/htconfig.md b/doc/htconfig.md index b2f718296..b2f7cf66e 100644 --- a/doc/htconfig.md +++ b/doc/htconfig.md @@ -25,7 +25,7 @@ Example: To set the directory value please add this line to your .htconfig.php: * **allowed_link_protocols** (Array) - Allowed protocols in links URLs, add at your own risk. http is always allowed. * **birthday_input_format** - Default value is "ymd". * **block_local_dir** (Boolean) - Blocks the access to the directory of the local users. -* **auth_cookie_lifetime** (Integer) - Number of days that should pass without any activity from a before before the users who choosed "Remember me" when logging in from that browser is considered logged out. Defaults to 7. +* **auth_cookie_lifetime** (Integer) - Number of days that should pass without any activity before a user who chose "Remember me" when logging in is considered logged out. Defaults to 7. * **curl_range_bytes** - Maximum number of bytes that should be fetched. Default is 0, which mean "no limit". * **db_log** - Name of a logfile to log slow database queries * **db_loglimit** - If a database call lasts longer than this value it is logged @@ -41,13 +41,14 @@ Example: To set the directory value please add this line to your .htconfig.php: * **directory** - The path to global directory. If not set then "http://dir.friendi.ca" is used. * **disable_email_validation** (Boolean) - Disables the check if a mail address is in a valid format and can be resolved via DNS. * **disable_url_validation** (Boolean) - Disables the DNS lookup of an URL. +* **dlogfile - location of the developer log file * **event_input_format** - Default value is "ymd". * **frontend_worker_timeout** - Value in minutes after we think that a frontend task was killed by the webserver. Default value is 10. * **ignore_cache** (Boolean) - For development only. Disables the item cache. * **like_no_comment** (Boolean) - Don't update the "commented" value of an item when it is liked. * **local_block** (Boolean) - Used in conjunction with "block_public". -* **local_search** (Boolean) - Blocks the search for not logged in users to prevent crawlers from blocking your system. -* **max_connections** - The poller process isn't started when the maximum level of the possible database connections are used. When the system can't detect the maximum numbers of connection then this value can be used. +* **local_search** (Boolean) - Blocks search for users who are not logged in to prevent crawlers from blocking your system. +* **max_connections** - The maximum number of database connections which can be in use before the poller process is deferred to it's next interval. When the system can't detect the maximum numbers of connection then this value can be used. * **max_connections_level** - The maximum level of connections that are allowed to let the poller start. It is a percentage value. Default value is 75. * **max_contact_queue** - Default value is 500. * **max_batch_queue** - Default value is 1000. diff --git a/doc/makingnewfriends.md b/doc/makingnewfriends.md deleted file mode 100644 index 7eff1eda1..000000000 --- a/doc/makingnewfriends.md +++ /dev/null @@ -1,11 +0,0 @@ -This is your Suggested Friends page. If you get lost, you can click this link to bring yourself back here. - -This is a bit like the Friend Suggestions page of Facebook. Everybody on this list has agreed that they may be suggested as a friend. This means they're unlikely to refuse an introduction you send, and they want to meet new people too! - -See somebody you like the look of? Click the connect button beneath their photograph. This will bring you to the introductions page. Fill in the form as instructed, and add a small note (optional). Now, wait a bit and they'll accept your request - note that these are real people, and it might take a while. Now you've added one, you're probably lost. Click the link at the top of this page to go back to the suggested friends list and add some more. - -Feel uncomfortable adding people you don't know? Don't worry - that's where Groups and Pages come in! - - - - diff --git a/doc/network.md b/doc/network.md deleted file mode 100644 index 36be159ea..000000000 --- a/doc/network.md +++ /dev/null @@ -1,14 +0,0 @@ -This is your Network Tab. -If you get lost, you can click this link to bring yourself back here. - -This is a bit like the Newsfeed at Facebook or the Stream at Diaspora. -It's where all the posts from your contacts, groups, and feeds will appear. -If you're new, you won't see anything in this page, unless you posted your status in the last step. -If you've already added a few friends, you'll be able to see their posts. -Here, you can comment, like, or dislike posts, or click on somebody's name to visit their profile page where you can write on their wall. - -Now we need to fill it up, the first step, is to make some new friends. - - - - diff --git a/doc/smarty3-templates.md b/doc/smarty3-templates.md index 751ef20b3..fb7036896 100644 --- a/doc/smarty3-templates.md +++ b/doc/smarty3-templates.md @@ -35,7 +35,7 @@ Form Templates To guarantee a consistent look and feel for input forms, i.e. in the settings sections, there are templates for the basic form fields. They are initialized with an array of data, depending on the tyle of the field. -All of these take an array for holding the values, i.e. for an one line text input field, which is required and should be used to type email addesses use something along +All of these take an array for holding the values, eg,. for a one line text input field, which is required and should be used to type email addesses use something along the lines of: '$adminmail' => array('adminmail', t('Site administrator email address'), $adminmail, t('Your account email address must match this in order to use the web admin panel.'), 'required', '', 'email'), diff --git a/doc/themes.md b/doc/themes.md index b553debfd..058eb49d8 100644 --- a/doc/themes.md +++ b/doc/themes.md @@ -3,7 +3,7 @@ * [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. +The current default theme is [Vier](https://github.com/friendica/friendica/tree/master/view/theme/vier) 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. @@ -69,7 +69,7 @@ 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.. +And similar steps are needed for *quattro* but this theme is using [lessc](http://lesscss.org/#docs) to maintain the CSS files.. In @@ -159,7 +159,7 @@ If you think your color variation could be benifical for other friendica users a ### Inheritation -Say, you like the duepuntozero but you want to have the content of the outer columns left and right exchanged. +Say, you like the duepuntozero but you want to have the content of the outer columns left and right exchanged. That would be not a color variation as shown above. Instead we will create a new theme, duepuntozero_lr, inherit the properties of duepuntozero and make small changes to the underlying php files. @@ -202,7 +202,7 @@ That done, you can select it in the settings like any other activated theme. ## Creating a Theme from Scratch Keep patient. -Basically what you have to do is identifying which template you have to change so it looks more like what you want. +Basically what you have to do is identify which template you have to change so it looks more like what you want. Adopt the CSS of the theme accordingly. And iterate the process until you have the theme the way you want it. @@ -243,11 +243,11 @@ For example, have a look at the theme.php of the *quattro* theme: */ You see the definition of the themes name, it's version and the initial author of the theme. -These three information should be listed. -If the original author is not anymore working on the theme, but a maintainer has taken over, the maintainer should be listed as well. +These three pieces of information should be listed. +If the original author is no longer working on the theme, but a maintainer has taken over, the maintainer should be listed as well. The information from the theme header will be displayed in the admin panelö. -Next crucial part of the theme.php file is a definition of an init function. +The next crucial part of the theme.php file is a definition of an init function. The name of the function is _init. So in the case of quattro it is @@ -256,7 +256,7 @@ So in the case of quattro it is set_template_engine($a, 'smarty3'); } -Here we have set the basic theme information, in this case they are empthy. +Here we have set the basic theme information, in this case they are empty. But the array needs to be set. And we have set the template engine that should be used by friendica for this theme. At the moment you should use the *smarty3* engine. @@ -289,4 +289,4 @@ The default file is in /view/default.php if you want to change it, say adding a 4th column for banners of your favourite FLOSS projects, place a new default.php file in your theme directory. -As with the theme.php file, you can use the properties of the $a variable with holds the friendica application to decide what content is displayed. \ No newline at end of file +As with the theme.php file, you can use the properties of the $a variable with holds the friendica application to decide what content is displayed. diff --git a/doc/translations.md b/doc/translations.md index 61d91bee5..c14b685be 100644 --- a/doc/translations.md +++ b/doc/translations.md @@ -6,7 +6,7 @@ Friendica translations Translation Process ------------------- -The strings used in the UI of Friendica is translated at [Transifex] [1] and then included in the git repository at github. +The strings used in the UI of Friendica are translated at [Transifex] [1] and then included in the git repository at github. If you want to help with translation for any language, be it correcting terms or translating friendica to a currently not supported language, please register an account at transifex.com and contact the friendica translation team there. Translating friendica is simple. @@ -22,7 +22,7 @@ If you want to help translating, please concentrate on the core messages.po file We will only include translations with a sufficient translated messages.po file. Translations of addons will only be included, when the core file is included as well. -If you want to get your work into the source tree yourself, feel free to do so and contact us with and question that arises. +If you want to get your work into the source tree yourself, feel free to do so and contact us with and questions that arise. The process is simple and friendica ships with all the tools necessary. The location of the translated files in the source tree is From e41c983f2ee4f299f4dca460bce56eefd085eee0 Mon Sep 17 00:00:00 2001 From: Thomas Willingham Date: Sat, 20 May 2017 02:38:01 +0100 Subject: [PATCH 2/2] Switch image URL to master branch --- doc/BBCode.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/BBCode.md b/doc/BBCode.md index b4b7faf64..6eebed486 100644 --- a/doc/BBCode.md +++ b/doc/BBCode.md @@ -65,13 +65,13 @@ table.bbcodes > * > tr > th { Friendica - [img]https://raw.githubusercontent.com/friendica/friendica/develop/images/friendica-32.jpg[/img] - Immagine/foto + [img]https://raw.githubusercontent.com/friendica/friendica/master/images/friendica-32.jpg[/img] + Immagine/foto - [img=64x32]https://raw.githubusercontent.com/friendica/friendica/develop/images/friendica-32.jpg[/img]
+ [img=64x32]https://raw.githubusercontent.com/friendica/friendica/master/images/friendica-32.jpg[/img]

Note: provided height is simply discarded. - + [size=xx-small]small text[/size]