Skip to content

Changes

Page history
update wiki after markdown reformat authored by Vladimir Schneider's avatar Vladimir Schneider
Hide whitespace changes
Inline Side-by-side
Installation.md
View page @ 255cbdf8
1. Require this package in your composer.json and run composer update (or run `composer require
vsch/laravel-translation-manager:*` directly):
1. Require this package in your composer.json and run composer update (or run `composer require
vsch/laravel-translation-manager:*` directly):
```json
"require": {
"vsch/laravel-translation-manager": "~2.1"
}
```
- if you are not going to be customizing the web interface it is highly recommended that you
add automatic asset publishing for this package after upgrade in your project's
composer.json:
......@@ -21,7 +20,7 @@
]
},
```
Otherwise a future update, that needs new assets, will not work properly. composer does not
run post-update scripts of packages.
......@@ -52,9 +51,9 @@
}
}
```
2. After updating composer, add the ServiceProviders to the providers array in config/app.php
and comment out the original TranslationServiceProvider:
2. After updating composer, add the ServiceProviders to the providers array in config/app.php
and comment out the original TranslationServiceProvider:
```php
//Illuminate\Translation\TranslationServiceProvider::class,
......@@ -63,7 +62,7 @@
//Vsch\UserPrivilegeMapper\UserPrivilegeMapperServiceProvider::class,
Collective\Html\HtmlServiceProvider::class,
```
The TranslationServiceProvider is an extension to the standard functionality and is required
in order for the web interface to work properly. It is backward compatible with the existing
Translator since it is a subclass of it and only overrides implementation for new features.
......@@ -73,7 +72,7 @@
**If you are upgrading from version 2.0.x of LTM** you need to remove the dependency to
UserPrivilegeMapper from your application service providers, shown commented out above.
3. add the Facade to the aliases array in config/app.php:
3. add the Facade to the aliases array in config/app.php:
```php
'Form' => Collective\Html\FormFacade::class,
......@@ -84,11 +83,11 @@
##### Removing dependency on UserPrivilegeMapper from facade alias array
**If you are upgrading from version 2.0.x of LTM** you need to remove the dependency to
UserPrivilegeMapper from your application facade alias array, shown commented out above.
UserPrivilegeMapper from your application facade alias array, shown commented out above.
4.
##### Publishing and running migrations
You need to publish then run the migrations for this package:
##### Publishing and running migrations
4. You need to publish then run the migrations for this package:
```bash
$ php artisan vendor:publish --provider="Vsch\TranslationManager\ManagerServiceProvider" --tag=migrations
......@@ -108,70 +107,69 @@ You need to publish then run the migrations for this package:
also need to configure the translation manager to use this as the default connection for
translation related tables. See
[[Changing the database name|Configuration#changing-the-database-name]]
##### Publishing the configuration
5.
##### Publishing the configuration
You need to publish the config file for this package. This will add the file
`config/laravel-translation-manager.php`
5. You need to publish the config file for this package. This will add the file
`config/laravel-translation-manager.php`
```bash
$ php artisan vendor:publish --provider="Vsch\TranslationManager\ManagerServiceProvider" --tag=config
```
6. You need to publish the web assets used by the translation manager web interface. This will
add the assets to `public/vendor/laravel-translation-manager`
6. You need to publish the web assets used by the translation manager web interface. This will
add the assets to `public/vendor/laravel-translation-manager`
```bash
$ php artisan vendor:publish --provider="Vsch\TranslationManager\ManagerServiceProvider" --tag=public
```
7. By default the web interface of the translation manager is available at
`http://yourdomain.com/translations`. You can change this in the configuration file. The
configuration file has 'web' and 'auth' middleware enabled on translator web interface
routes, 'web' is required 'auth' is optional, you can add any other middleware to the route
that you require.
7. By default the web interface of the translation manager is available at
`http://yourdomain.com/translations`. You can change this in the configuration file. The
configuration file has 'web' and 'auth' middleware enabled on translator web interface
routes, 'web' is required 'auth' is optional, you can add any other middleware to the route
that you require.
8.
##### Setting up user authorization
TranslationManager uses Laravel 5.2 abilities for providing authorization for various
##### Setting up user authorization
8. TranslationManager uses Laravel 5.2 abilities for providing authorization for various
translation functions. These abilities can be defined in the app's
`AuthServiceProvider::boot` function, see example below.
You need to define the following abilities:
- `ltm-admin-translations` true/false if user can administer translations only used if
`admin_translations` option is set to true in LTM config.
- `ltm-bypass-lottery` true/false if user bypasses the missing key lottery and all missing keys
are displayed for the user.
- `ltm-bypass-lottery` true/false if user bypasses the missing key lottery and all missing
keys are displayed for the user.
- `ltm-list-editors` true/false, if user can manage per locale user list. This one is
optional and only used if you have `user_locales_enabled` set to `true` in the config
file. See:
[Enabling per locale user access control](Configuration#enabling-per-locale-user-access-control)
this ability function takes 3 arguments:
this ability function takes 3 arguments:
1. `$user` - the currently logged in user
2. `$connection_name` - current connection name, '' or null means default
3. `&$user_list` - reference in which to return the list of users that can be managed by the
currently logged in user.
This should only return a list of users that have access to the translation manager web
UI. Please keep in mind that by default a user can modify any locale if there is no
entry for this user in the `ltm_user_locales` table or if the entry is null or empty. By
this measure the table contains entries for users wih limited access. Any user that has
access to translation manager web UI and no entry in the `ltm_user_locales` table will
be able to edit translations in any locale. If you don't want a user to access any
locales then they should not have access to the LTM web UI through the Laravel
middleware authorization mechanism.
3. `&$user_list` - reference in which to return the list of users that can be managed by
the currently logged in user.
This should only return a list of users that have access to the translation manager
web UI. Please keep in mind that by default a user can modify any locale if there is
no entry for this user in the `ltm_user_locales` table or if the entry is null or
empty. By this measure the table contains entries for users wih limited access. Any
user that has access to translation manager web UI and no entry in the
`ltm_user_locales` table will be able to edit translations in any locale. If you
don't want a user to access any locales then they should not have access to the LTM
web UI through the Laravel middleware authorization mechanism.
Here is an example implementing these abilities in the app's `AuthServiceProvider::boot`
function:
```php
$gate->define('ltm-admin-translations', function ($user) {
/* @var $user \App\User */
......@@ -198,56 +196,56 @@ You need to publish the config file for this package. This will add the file
return $user_list;
});
```
In this example the User model implements two attributes: is_admin and is_editor. The admin
user is allowed to manage translations: import, delete, export, etc., the editor user can
only edit existing translations. However, both of these users will always log missing
translation keys so that any missing translations will be visible to them instead of relying
on the session winning the missing key lottery before logging missing keys.
**If you are upgrading from version 2.0.x of LTM** you need to remove the
UserPrivilegeMapper definitions added in your application, probably in
`app/Providers/AppServiceProvider.php`
9. Yandex assisted translations requires setting the `yandex_translator_key` to your Yandex API
key in the `config/laravel-translation-manager.php` file, it is free to get and use. See:
<https://tech.yandex.com/translate/>
10.
##### Overriding the Web Interface Translations
If you want to override the Translation Manager web interface
translations or add another locale you will need to publish the language files to your
project by executing:
9. Yandex assisted translations requires setting the `yandex_translator_key` to your Yandex API
key in the `config/laravel-translation-manager.php` file, it is free to get and use. See:
<https://tech.yandex.com/translate/>
##### Overriding the Web Interface Translations
10. If you want to override the Translation Manager web interface translations or add another
locale you will need to publish the language files to your project by executing:
```bash
$ php artisan vendor:publish --provider="Vsch\TranslationManager\ManagerServiceProvider" --tag=lang
```
This will copy the translations to your project and allow you to view/edit them in the
translation manager web interface.
11.
##### Customizing Views
If you want to customize views for the Translation Manager web interface
you will need to publish the views to your project by executing:
##### Customizing Views
11. If you want to customize views for the Translation Manager web interface you will need to
publish the views to your project by executing:
```bash
$ php artisan vendor:publish --provider="Vsch\TranslationManager\ManagerServiceProvider" --tag=views
```
This will copy the views to your project under the
`resources/views/vendor/laravel-translation-manager` directory. See:
[[Modifying the default Views|Configuration#modifying-the-default-views]]
12.
##### Markdown to HTML conversion
This option can be used to automatically convert translations for keys with a given suffix to
HTML and store the result for a key with the suffix removed. Can be used for translations that
contain HTML. By default this option is disabled. Enabling it would require that you also
install a package that does the HTML conversion. See
[[Markdown to HTML conversion|Configuration#markdown-to-html-conversion]]
13.
##### Enabling Edit In-Place on you pages
Allowing edit in-place of your site's pages will require some modification to views to support
this functionality [[Markdown to HTML conversion|Configuration#markdown-to-html-conversion]]
##### Markdown to HTML conversion
12. This option can be used to automatically convert translations for keys with a given suffix
to HTML and store the result for a key with the suffix removed. Can be used for translations
that contain HTML. By default this option is disabled. Enabling it would require that you
also install a package that does the HTML conversion. See
[[Markdown to HTML conversion|Configuration#markdown-to-html-conversion]]
##### Enabling Edit In-Place on you pages
13. Allowing edit in-place of your site's pages will require some modification to views to
support this functionality
[[Markdown to HTML conversion|Configuration#markdown-to-html-conversion]]