RedGuy/easy-18in
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Optimize plugin description section

Browse Source
This commit is contained in:
Marcel Haßlinger 2021-03-15 11:42:07 +01:00
parent 94f88d482d
commit f370b405d2
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -15,13 +15,10 @@
<!-- Plugin description --> <!-- Plugin description -->
This is an easy plugin to manage internationalization for JSON or Resource-Bundle(Properties) based locale files. This is an easy plugin to manage internationalization for JSON or Resource-Bundle(Properties) based locale files.
Most common use case is for translating Webapps or simple Java Applications. Most common use case is for translating Webapps or simple Java Applications. Translating large scale projects was never that easy with your favourite IDE!
![Tree View](https://raw.githubusercontent.com/marhali/easy-i18n/main/example/images/TreeView.PNG "Tree View")
![Table View](https://raw.githubusercontent.com/marhali/easy-i18n/main/example/images/TableView.PNG "Table View")
## Use Cases ## Use Cases
- Webapps: [Vue](https://vuejs.org/) with [vue-i18n](https://kazupon.github.io/vue-i18n/) or any other JSON translation file based technology - Webapps: For example [Vue](https://vuejs.org/) with [vue-i18n](https://kazupon.github.io/vue-i18n/) or any other JSON translation file based technology
- Java based Resource-Bundle - Java based Resource-Bundle
## Features ## Features
@ -32,18 +29,14 @@ Most common use case is for translating Webapps or simple Java Applications.
- Translation keys with missing definition for any locale will be displayed red - Translation keys with missing definition for any locale will be displayed red
- Quick edit any translation by right-click (IntelliJ Popup Action) - Quick edit any translation by right-click (IntelliJ Popup Action)
- Quick delete any translation via <kbd>DEL</kbd>-Key - Quick delete any translation via <kbd>DEL</kbd>-Key
## Configuration
- Install plugin. See **Installation** section
- Create a directory which will hold the locale files
- Create a file for each required locale (e.g de.json, en.json) Note: Each json file must at least define an empty section (e.g. **{}**)
- Click on the **Settings** Action inside the Easy I18n Tool Window
- Select the created directory (optional: define the preferred locale to view) and press Ok
- Translations can now be created / edited or deleted
<!-- Plugin description end --> <!-- Plugin description end -->
## Installation ## Screenshots
![Tree View](https://raw.githubusercontent.com/marhali/easy-i18n/main/example/images/TreeView.PNG "Tree View")
![Table View](https://raw.githubusercontent.com/marhali/easy-i18n/main/example/images/TableView.PNG "Table View")
## Installation
- Using IDE built-in plugin system: - Using IDE built-in plugin system:
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "easy-i18n"</kbd> > <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "easy-i18n"</kbd> >
@ -54,6 +47,13 @@ Most common use case is for translating Webapps or simple Java Applications.
Download the [latest release](https://github.com/marhali/easy-i18n/releases/latest) and install it manually using Download the [latest release](https://github.com/marhali/easy-i18n/releases/latest) and install it manually using
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd> <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
## Configuration
- Install plugin. See **Installation** section
- Create a directory which will hold the locale files
- Create a file for each required locale (e.g de.json, en.json) Note: Each json file must at least define an empty section (e.g. **{}**)
- Click on the **Settings** Action inside the Easy I18n Tool Window
- Select the created directory (optional: define the preferred locale to view) and press Ok
- Translations can now be created / edited or deleted
--- ---
Plugin based on the [IntelliJ Platform Plugin Template][template]. Plugin based on the [IntelliJ Platform Plugin Template][template].