GitHub
commit
a7fd9e3223
222 changed files with 494 additions and 497 deletions
|
|
@ -305,7 +305,7 @@ Returns [Private Messages](help/API-Entities#Private+message) matching the provi
|
|||
#### Parameters
|
||||
|
||||
* `searchstring`: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
|
||||
* `getText` (optional): `plain`|`html` If ommited, the title is prepended to the plaintext body in the `text` attribute of the private message objects.
|
||||
* `getText` (optional): `plain`|`html` If omitted, the title is prepended to the plaintext body in the `text` attribute of the private message objects.
|
||||
* `getUserObjects` (optional): `true`|`false` If `false`, the `sender` and `recipient` attributes of the private message object are absent.
|
||||
|
||||
#### Return values
|
||||
|
|
@ -646,7 +646,7 @@ On error:
|
|||
|
||||
* 403 FORBIDDEN: if not authenticated
|
||||
* 400 BADREQUEST: "no albumname specified", "album not available"
|
||||
* 500 INTERNALSERVERERROR: "problem with deleting item occured", "unknown error - deleting from database failed"
|
||||
* 500 INTERNALSERVERERROR: "problem with deleting item occurred", "unknown error - deleting from database failed"
|
||||
|
||||
### POST api/friendica/photoalbum/update
|
||||
|
||||
|
|
|
|||
|
|
@ -265,7 +265,7 @@ Example:
|
|||
|
||||
## Currently unimplemented endpoints
|
||||
|
||||
These emdpoints are planned to be implemented somewhere in the future.
|
||||
These endpoints are planned to be implemented somewhere in the future.
|
||||
|
||||
- [`POST /api/v1/accounts/:id/remove_from_followers`](https://github.com/mastodon/mastodon/pull/16864)
|
||||
- [`GET /api/v1/accounts/familiar_followers`](https://github.com/mastodon/mastodon/pull/17700)
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ 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's 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, there is a [list of public servers here](https://dir.friendica.social/servers) and hopefully you will find one that meets your needs.
|
||||
If the site you're visiting doesn't allow registration, or you think you might prefer another one, there is a [list of public servers here](https://dir.friendica.social/servers) and hopefully you will 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://friendi.ca/) to download the code with setup instructions.
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ See doxygen documentation of `IWritableStorage` interface for details about each
|
|||
|
||||
## Register a storage backend class
|
||||
|
||||
Each backend must be registered in the system when the plugin is installed, to be aviable.
|
||||
Each backend must be registered in the system when the plugin is installed, to be available.
|
||||
|
||||
`DI::facStorage()->register(string $class)` is used to register the backend class.
|
||||
|
||||
|
|
@ -140,18 +140,18 @@ abstract class StorageTest
|
|||
|
||||
There are two intended types of exceptions for storages
|
||||
|
||||
### `ReferenceStorageExecption`
|
||||
### `ReferenceStorageException`
|
||||
|
||||
This storage exception should be used in case the caller tries to use an invalid references.
|
||||
This could happen in case the caller tries to delete or update an unknown reference.
|
||||
The implementation of the storage backend must not ignore invalid references.
|
||||
|
||||
Avoid throwing the common `StorageExecption` instead of the `ReferenceStorageException` at this particular situation!
|
||||
Avoid throwing the common `StorageException` instead of the `ReferenceStorageException` at this particular situation!
|
||||
|
||||
### `StorageException`
|
||||
|
||||
This is the common exception in case unexpected errors happen using the storage backend.
|
||||
If there's a predecessor to this exception (e.g. you caught an exception and are throwing this execption), you should add the predecessor for transparency reasons.
|
||||
If there's a predecessor to this exception (e.g. you caught an exception and are throwing this exception), you should add the predecessor for transparency reasons.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -320,7 +320,7 @@ The file is `addon/samplestorage/samplestorage.php`
|
|||
<?php
|
||||
/**
|
||||
* Name: Sample Storage Addon
|
||||
* Description: A sample addon which implements an unusefull storage backend
|
||||
* Description: A sample addon which implements a very limited storage backend
|
||||
* Version: 1.0.0
|
||||
* Author: Alice <https://alice.social/~alice>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@ function <addon>_footer()
|
|||
### JavaScript hooks
|
||||
|
||||
The main Friendica script provides hooks via events dispatched on the `document` property.
|
||||
In your Javascript file included as described above, add your event listener like this:
|
||||
In your JavaScript file included as described above, add your event listener like this:
|
||||
|
||||
```js
|
||||
document.addEventListener(name, callback);
|
||||
|
|
@ -133,7 +133,7 @@ document.addEventListener(name, callback);
|
|||
- *name* is the name of the hook and corresponds to a known Friendica JavaScript hook.
|
||||
- *callback* is a JavaScript anonymous function to execute.
|
||||
|
||||
More info about Javascript event listeners: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
|
||||
More info about JavaScript event listeners: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
|
||||
|
||||
#### Current JavaScript hooks
|
||||
|
||||
|
|
@ -425,7 +425,7 @@ Called after HTML content functions have completed.
|
|||
|
||||
### footer
|
||||
Called after HTML content functions have completed.
|
||||
Deferred Javascript files should be registered using this hook.
|
||||
Deferred JavaScript files should be registered using this hook.
|
||||
`$b` is (string) HTML of footer div/element.
|
||||
|
||||
### avatar_lookup
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ You can use several servers to create an account:
|
|||
|
||||
### 1. Basics
|
||||
|
||||
At first you have to get the current version. You can either pull it from [Github](https://github.com) like so:
|
||||
At first you have to get the current version. You can either pull it from [GitHub](https://github.com) like so:
|
||||
|
||||
$> cd /var/www/virtual/YOURSPACE/html/addon; git pull
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ Composer requires PHP CLI and the following examples assume it's available syste
|
|||
|
||||
#### From Archive
|
||||
|
||||
If you just unpacked a Friendica release archive, you don't have to use Commposer at all, all the required libraries are already bundled in the archive.
|
||||
If you just unpacked a Friendica release archive, you don't have to use Composer at all, all the required libraries are already bundled in the archive.
|
||||
|
||||
#### Installing with Git
|
||||
|
||||
|
|
|
|||
|
|
@ -250,7 +250,7 @@ key = value
|
|||
<tr>
|
||||
<td><pre>
|
||||
[config]
|
||||
register_policty = REGISTER_CLOSED
|
||||
register_policy = REGISTER_CLOSED
|
||||
</pre></td>
|
||||
<td><pre>
|
||||
'config' => [
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@ Please remove all the `require_once` mentions of the former file, as they will p
|
|||
## Miscellaneous tips
|
||||
|
||||
When you are done with moving the class, please run `php bin/console.php typo` from the Friendica base directory to check for obvious mistakes.
|
||||
Howevever, this tool isn't bullet-proof, and a staging install of Friendica is recommended to test your class move without impairing your production server if you host one.
|
||||
However, this tool isn't bullet-proof, and a staging install of Friendica is recommended to test your class move without impairing your production server if you host one.
|
||||
|
||||
Most of Friendica processes are run in the background, so make sure to turn on your debug log to check for errors that wouldn't show up while simply browsing Friendica.
|
||||
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ For documentation we use the standard of *one sentence per line* for the `md` fi
|
|||
|
||||
#### Check with [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer)
|
||||
|
||||
This tool checks your files against a variety of coding standards, including PSR-2, and ouputs a report of all the standard violations.
|
||||
This tool checks your files against a variety of coding standards, including PSR-2, and outputs a report of all the standard violations.
|
||||
You can simply install it through PEAR: `pear install PHP_CodeSniffer`
|
||||
Once it is installed and available in your PATH, here's the command to run before committing your work:
|
||||
|
||||
|
|
@ -109,7 +109,7 @@ Here's the command to automatically fix the files you created/modified:
|
|||
|
||||
$> phpcbf --standard=ruleset.xml <file or directory>
|
||||
|
||||
If the command-line tools `diff` and `patch` are unavailabe for you, `phpcbf` can use slightly slower PHP equivalents by using the `--no-patch` argument.
|
||||
If the command-line tools `diff` and `patch` are unavailable for you, `phpcbf` can use slightly slower PHP equivalents by using the `--no-patch` argument.
|
||||
|
||||
### Code documentation
|
||||
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ Friendica Documentation and Resources
|
|||
|
||||
* [Get started](help/Developers-Intro)
|
||||
* Set up development environment
|
||||
* [Help on Github](help/Github)
|
||||
* [Help on GitHub](help/GitHub)
|
||||
* [Help on Vagrant](help/Vagrant)
|
||||
* [Bugs and Issues](help/Bugs-and-Issues)
|
||||
* Code structure
|
||||
|
|
|
|||
|
|
@ -231,7 +231,7 @@ Copy `.htaccess-dist` to `.htaccess` (be careful under Windows) to have working
|
|||
|
||||
Example:
|
||||
|
||||
cp .htacces-dist .htaccess
|
||||
cp .htaccess-dist .htaccess
|
||||
|
||||
*Note*: Do **not** rename the `.htaccess-dist` file as it is tracked by GIT and renaming will cause a dirty working directory.
|
||||
|
||||
|
|
@ -353,7 +353,7 @@ Often this will need to be resolved with your hosting provider or (if self-hoste
|
|||
First check your file permissions.
|
||||
Your website and all contents must generally be world-readable.
|
||||
|
||||
Ensure that mod-rewite is installed and working, and that your `.htaccess` file
|
||||
Ensure that mod-rewrite is installed and working, and that your `.htaccess` file
|
||||
is being used. To verify the latter, create a file `test.out` containing the
|
||||
word "test" in the top directory of Friendica, make it world readable and point
|
||||
your web browser to
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ You can also use your Identity Address or other people's Identity Addresses to b
|
|||
Currently, Friendica supports connections with people on diaspora*, Red, Hubzilla, GNU Social, StatusNet, Mastodon, Pleroma, socialhome, and ganggo platforms.
|
||||
|
||||
If you know (for instance) "alice" on gnusocial.net (a GNU Social site) you could put alice@gnusocial.net into your Contact page and become friends across networks.
|
||||
Likwise you can put in the URL to Alice's gnusocial.net page, if you wish.
|
||||
Likewise you can put in the URL to Alice's gnusocial.net page, if you wish.
|
||||
Note: Some versions of GNU Social software may require the full URL to your profile and may not work with the identity address.
|
||||
|
||||
People on these networks can also initiate contact with you, if they know your contact details.
|
||||
|
|
@ -74,7 +74,7 @@ Create an email contact with for example Alice on Gmail, enter her email in foll
|
|||
In order to avoid abuse or spam, you must have an email from Alice with the correct email address in your email inbox.
|
||||
|
||||
Subscribing to mailing lists is done in the same way, but without the use of the "mailto:" prefix.
|
||||
To subscribe to a mailing list, enter the email in following example format "mailling-list@list-server.net".
|
||||
To subscribe to a mailing list, enter the email in following example format "mailing-list@list-server.net".
|
||||
|
||||
### Syndication feeds
|
||||
You can "follow" almost anybody or any website that produces a syndication feed (RSS/Atom,etc.).
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ Friendica contacts
|
|||
---
|
||||
Friendica will recreate your account on the new server, with your contacts and groups.
|
||||
A message is sent to Friendica contacts, to inform them about your move:
|
||||
If your contacts are runnning on an updated server, your details on their side will be automatically updated.
|
||||
If your contacts are running on an updated server, your details on their side will be automatically updated.
|
||||
|
||||
GNU Social contacts
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ 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 a Facebook wall.
|
||||
It's where all your status messgages are kept, and where your friends come to post on your wall.
|
||||
It's where all your status messages are kept, and where your friends come to post on your wall.
|
||||
|
||||
To write your status, simply click on the Pencil & Paper icon in the top right (in the Frio theme), or click in the box that says "share" (other themes).
|
||||
When you do this, the posting dialog box will appear or the share box will expand.
|
||||
|
|
|
|||
|
|
@ -104,12 +104,12 @@ Default is false.
|
|||
#### File storage backend
|
||||
|
||||
Set the backend used by Friendica to store uploaded file data.
|
||||
Two storage backends are avaiable with Friendica:
|
||||
Two storage backends are available with Friendica:
|
||||
|
||||
- **Database** : Data is stored in a dedicated table in database (`storage`)
|
||||
- **Filesystem** : Data is stored as file on the filesystem.
|
||||
|
||||
More storage backends can be avaiable from third-party addons.
|
||||
More storage backends can be available from third-party addons.
|
||||
If you use those, please refer to the documentation of those addons for further information.
|
||||
|
||||
Default value is 'Database (legacy)': it's the legacy way used to store data directly in database.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ If 2FA is already enabled and you want to add another device, you must re-config
|
|||
### 1. Download an authenticator app
|
||||
|
||||
Any authenticator app should work with Friendica.
|
||||
Notheless, we recommend:
|
||||
Nonetheless, we recommend:
|
||||
|
||||
- For iOS, [Matt Rubin's MIT-licensed Authenticator app](https://mattrubin.me/authenticator).
|
||||
- For Android, [andOTP](https://github.com/andOTP/andOTP).
|
||||
|
|
@ -68,7 +68,7 @@ Instead, if you enabled two-factor authentication, you have to generate app-spec
|
|||
|
||||
You can generate as many app-specific passwords as you want, they will be shown once to you just after you generated it.
|
||||
Just copy and paste it in your third-party app in the Friendica account password input field at this point.
|
||||
We recommend generating a single app-specific password for each separate third-party app you are using, using a meaningul description of the target app (like "Frienqa on my Fairphone 2").
|
||||
We recommend generating a single app-specific password for each separate third-party app you are using, using a meaningful description of the target app (like "Frienqa on my Fairphone 2").
|
||||
|
||||
You can also revoke any and all app-specific password you generated this way.
|
||||
This may log you out of the third-party application(s) you used the revoked app-specific password to log in with.
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ The mysql database is called "friendica", the mysql user and password both are "
|
|||
Your local working directory is set up as a shared directory with the VM (/vagrant).
|
||||
7. Check the changes in your browser in the VM.
|
||||
Find the Friendica log file `/vagrant/logfile.out` on the VM or in the `logfile.out` in you local Friendica directory.
|
||||
8. Commit and push your changes directly back to Github.
|
||||
8. Commit and push your changes directly back to GitHub.
|
||||
|
||||
If you want to stop vagrant after finishing your work, run the following command
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Fields
|
|||
| verified | user is verified through email | boolean | NO | | 0 | |
|
||||
| blocked | 1 for user is blocked | boolean | NO | | 0 | |
|
||||
| blockwall | Prohibit contacts to post to the profile page of the user | boolean | NO | | 0 | |
|
||||
| hidewall | Hide profile details from unkown viewers | boolean | NO | | 0 | |
|
||||
| hidewall | Hide profile details from unknown viewers | boolean | NO | | 0 | |
|
||||
| blocktags | Prohibit contacts to tag the post of this user | boolean | NO | | 0 | |
|
||||
| unkmail | Permit unknown people to send private mails to this user | boolean | NO | | 0 | |
|
||||
| cntunkmail | | int unsigned | NO | | 10 | |
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ 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 a few days days at the beginning and the end.
|
||||
The overview page shows the calendar of the current month, plus a few 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,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 holding the values, e.g. for a one line text input field, which is required and should be used to type email addesses use something along the lines of:
|
||||
All of these take an array holding the values, e.g. for a one line text input field, which is required and should be used to type email addresses use something along the lines of:
|
||||
|
||||
'$adminmail' => array('adminmail', DI::l10n()->t('Site administrator email address'), $adminmail, DI::l10n()->t('Your account email address must match this in order to use the web admin panel.'), 'required', '', 'email'),
|
||||
|
||||
|
|
@ -70,7 +70,7 @@ Field parameter:
|
|||
|
||||
### field_custom.tpl
|
||||
|
||||
A customizeable template to include a custom element in the form with the usual surroundings,
|
||||
A customizable template to include a custom element in the form with the usual surroundings,
|
||||
Field parameter:
|
||||
|
||||
0. Name of the field,
|
||||
|
|
@ -88,7 +88,7 @@ Field parameter:
|
|||
2. Current value of the variable,
|
||||
3. Help text for the input box,
|
||||
4. Should be set to the translation of "Required" to mark this field as required,
|
||||
5. if set to "autofocus" modern browser will put the cursur into this box once the page is loaded,
|
||||
5. if set to "autofocus" modern browser will put the cursor into this box once the page is loaded,
|
||||
6. if set, it will be used for the input type, default is `text` (possible types: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#%3Cinput%3E_types).
|
||||
|
||||
### field_intcheckbox.tpl
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ 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.
|
||||
If you are almost happy with an existing theme, the easiest way to cover your needs is to create a new theme, inheriting 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.
|
||||
|
|
@ -33,7 +33,7 @@ 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.
|
||||
This is only needed if the theme allows the user to change certain things of the theme dynamically.
|
||||
Say the font size or set a background image.
|
||||
|
||||
### Templates
|
||||
|
|
@ -50,7 +50,7 @@ if you want to override any template within your theme create your version of th
|
|||
|
||||
any template that exists there will be used instead of the default one.
|
||||
|
||||
### Javascript
|
||||
### JavaScript
|
||||
|
||||
The same rule applies to the JavaScript files found in
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Friendica translations
|
|||
|
||||
The Friendica translation process is based on `gettext` PO files.
|
||||
|
||||
Basic worflow:
|
||||
Basic workflow:
|
||||
1. `xgettext` is used to collect translation strings across the project in the authoritative PO file located in `view/lang/C/messages.po`.
|
||||
2. This file makes translations strings available at [the Transifex Friendica page](https://www.transifex.com/Friendica/friendica/dashboard/).
|
||||
3. The translation itself is done at Transifex by volunteers.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue