Skip to content
This repository was archived by the owner on Oct 27, 2025. It is now read-only.

Commit 62c1198

Browse files
committed
Change readme + versionbump + build.
1 parent 329d6c1 commit 62c1198

File tree

6 files changed

+27
-28
lines changed

6 files changed

+27
-28
lines changed

.github/README.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,14 @@ Beta : This is a work in progress port of translations to Kirby 3. The "saved" s
66

77
This plugin enhances the translation handling of pages for [Kirby 3](http://getkirby.com) with the following features:
88

9-
## How it works
10-
11-
The plugin automatically detects if there's a language `.txt` file for the current page in your content folder and displays additional language tabs. For now there are two possible states:
12-
13-
+ **RED**: The translated `.txt`-file does not exist
14-
+ **GREEN**: The translated `.txt`-file exists
9+
- The language menu explicitly shows if the translation exists :
10+
- **RED**: The translated `.txt`-file does not exist
11+
- **GREEN**: The translated `.txt`-file exists
1512

1613
For all non-default languages you can:
1714

18-
- delete a translation (without deleting the whole page)
19-
- resynchronise translations with the default language file
15+
- Delete a translation (without deleting the whole page).
16+
- Resynchronise translations with the default language file (revert).
2017

2118
Also, the plugin offers an option to replace the kirby languages menu by an enhanced one.
2219

@@ -54,7 +51,21 @@ git submodule add https://github.com/daandelange/k3-translations.git site/plugin
5451

5552
## Setup
5653

57-
Add the following `section` to your blueprint.
54+
### Replacing Kirby's native language menu
55+
Within your website project, you can customise the header language menu as such:
56+
57+
```php
58+
// Site /site/config/config.php
59+
return [
60+
'daandelange.translations.options.header.replaceKirbyLanguages': false, // To disable replacing the native lang menu
61+
'daandelange.translations.options.header.compactMode': true, // To enable compact mode
62+
'daandelange.translations.options.header.delete': false, // To disallow deleting a language
63+
'daandelange.translations.options.header.revert': false, // To disallow reverting a language
64+
];
65+
```
66+
67+
### Translations Section
68+
Add the following `section` to your blueprint. (optional)
5869

5970
```yaml
6071
sections:
@@ -80,16 +91,8 @@ sections:
8091
revertable: false
8192
```
8293
83-
To replace kirby's default language switcher in the header, do …
84-
85-
```yaml
86-
sections:
87-
translations:
88-
type: translations
89-
portaled: false
90-
```
9194
92-
To use a more compact layout, do … *(automatically enabled if portaled)*
95+
To use a more compact layout, do …
9396
9497
```yaml
9598
sections:
@@ -100,10 +103,6 @@ sections:
100103
101104
Of course, you can combine all options.
102105
103-
## Known issues
104-
105-
For Kirby 3.5 and before, using the default language switcher in the Panel breaks the display of the actions (delete, revert), but this should be fixed for Kirby 3.6+
106-
107106
108107
## Development
109108

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "daandelange/k3-translations",
33
"description": "Translations field and section for Kirby 3",
44
"homepage": "https://github.com/Daandelange/k3-translations",
5-
"version": "0.1.0-beta",
5+
"version": "0.2.0-beta",
66
"type": "kirby-plugin",
77
"license": "MIT",
88
"authors": [

index.css

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

index.js

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

index.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
'delete' => true,
1919
'revert' => true,
2020
],
21-
2221
],
2322
'sections' => [
2423
'translations' => [

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "Translations",
3-
"version": "0.1.0-beta",
3+
"version": "0.2.0-beta",
44
"description": "Translations field and section for Kirby 3",
55
"main": "index.js",
66
"author": "Daan de Lange",
@@ -14,6 +14,6 @@
1414
"recognizeSelfClosing": true
1515
},
1616
"devDependencies": {
17-
"kirbyup": "^0.18.0"
17+
"kirbyup": "latest"
1818
}
1919
}

0 commit comments

Comments
 (0)