Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add french translation #1

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"cSpell.language": "en,fr"
}
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing to Code for IBM i

We welcome all users to contribute. Whether it be to documentation, or code, we love it all. We use a typical PR system:

1. You fork & clone
2. Commit and push changes to your fork
3. Make a pull request (PR)

If you are making a pull request which fixes a bug, adds a feature or changes documentation, expect your PR to be reviewed. Be sure to read [Contributing to projects](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) on the GitHub documentation.

If you want to help but you're unsure what to work on, here are two easy places to start:


# Previous contributors

Thanks so much to everyone [who has contributed](https://github.com/halcyon-tech/vscode-ibmi/graphs/contributors).

* [@connorholyday](https://github.com/connorholyday)
* [@worksofliam](https://github.com/worksofliam)
* [@alanseiden](https://github.com/alanseiden)
* [@richardschoen](https://github.com/richardschoen)
* [@barrettotte](https://github.com/barrettotte)
* [@thebeardedgeek](https://github.com/thebeardedgeek)
* [@dferrand](https://github.com/dferrand)
* [@dariocs](https://github.com/dariocs)
* [@priceaj](https://github.com/priceaj)
* [@sgi495](https://github.com/sgi495)
* [@SJLennon](https://github.com/SJLennon)
* [@onewheelonly](https://github.com/onewheelonly)
* [@chrjorgensen](https://github.com/chrjorgensen)
* [@szsascha](https://github.com/szsascha)
* [@dman247](https://github.com/dman247)
* [@EddieSmith](https://github.com/EddieSmith)
* [@fathert](https://github.com/fathert)
* [@Teqed](https://github.com/Teqed)
* [@jwoehr](https://github.com/jwoehr)
* [@Wright4i](https://github.com/Wright4i)
61 changes: 61 additions & 0 deletions TRANSLATING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Translating the Code for IBM i Documentation Web site.

## Translating is Contributing !

Translating the documentation Web site is contributing to Code For IBMI , so please read [CONTRIBUTING](CONTRIBUTING.md) before.

## Docsify
> A magical documentation site generator.

Code for IBMi uses [Docsify](https://docsify.js.org/#/) to publish the Web site [code-for-ibmi Documentation](https://halcyon-tech.github.io/vscode-ibmi/#/).

To sum it up , this tools transforms the **markdown** files stored in the [docs](./docs/) folder to a web site using [github pages](https://pages.github.com/).

This site is in English by default but it's possible to add a new language to improve the learning curve of the none english's adopters.

Please read above How to initiate or How to help in a new translating.

**Add a new language** is to add a new folder under [docs](./docs/) folder with all docs's markdown files translated.
To be meaningful we call this folder with the [ISO Language Code table](http://www.lingoes.net/en/translator/langcode.htm)

So for french we used **fr-FR**.
then the user switches between all the languages using the translations *navbar* in the right corner.

## Process to add a new language
We choose to use french translation as an example to explain the process.

1. Contributing
1. You fork and clone
1. Create an new branch
1. Translating
:eye_speech_bubble: To make me easier the translating,I'm using this useful extension [Vscode Google Translate](https://marketplace.visualstudio.com/items?itemName=funkyremi.vscode-google-translate)

1. Add the new language in the [navbar](./docs/_navbar.md) using the [ISO Language Code table](http://www.lingoes.net/en/translator/langcode.htm).
1. Copy the [docs](./docs/) folder as the [/docs/fr-FR](./docs/fr-FR/) folder.
1. Remove the _navbar.md under the [/docs/fr-FR](./docs/fr-FR/) folder.
1. Start translating the [side bar](./docs/fr-FR/_sidebar.md)
You have to change all the path to yours pages by adding the directory (/fr-FR/) in this case ..
```
- [Code for IBM i](/)
- [Login](/pages/login.md)
...
```
to
```
- [Code for IBM i](/fr-FR/)
- [Connexion](/fr-FR/pages/login.md)
...
```
1. Then you can translate the [readme](./docs/fr-FR/README.md).
1. Then you can test your job.
1. And/or translate all the markdown files under your folder.
1. Testing locally
1. Open a terminal in VSC
1. Type
`docsify serve docs`
1. Open your navigator on the url proposed
1. Testing Remotely
1. Commit and push changes to your fork
1. Deploy /docs of your fork to [github pages](https://docsify.js.org/#/deploy)
3. :heavy_check_mark: Make a pull request (PR)

4 changes: 4 additions & 0 deletions docs/_navbar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- _navbar.md -->
- Translations
- [:uk: English](/)
- [:fr: Français](/fr-FR/)
49 changes: 25 additions & 24 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
- [Code for IBM i](./README.md)
- [Login](pages/login.md)
- [Code for IBM i](/)
- [Login](/pages/login.md)
- Developing
- [Editing and compiling](pages/developing/editing-compiling.md)
- [Actions](pages/developing/actions/index.md)
- [Execution](pages/developing/actions/execution.md)
- [Custom Variables](pages/developing/actions/custom-vars.md)
- [ILEDocs](pages/developing/iledocs.md)
- [Editing and compiling](/pages/developing/editing-compiling.md)
- [Actions](/pages/developing/actions/index.md)
- [Execution](/pages/developing/actions/execution.md)
- [Custom Variables](/pages/developing/actions/custom-vars.md)
- [ILEDocs](/pages/developing/iledocs.md)
- Local Development
- [Getting started](pages/developing/local/getting-started.md)
- [Azure DevOps](pages/developing/local/azure.md)
- [Getting started](/pages/developing/local/getting-started.md)
- [Project Structure](pages/developing/local/structure.md)
- [Azure DevOps](/pages/developing/local/azure.md)
- Tips
- [Quick Start](pages/tips/quickstart.md)
- [Tricks](pages/tips/tricks.md)
- [Terminals](pages/tips/terminals.md)
- [CCSID](pages/tips/ccsid.md)
- [Setup](pages/tips/setup.md)
- [Browsers](pages/browsers/index.md)
- [User Library List](pages/browsers/user-library-list.md)
- [Object Browser](pages/browsers/object-browser.md)
- [IFS Browser](pages/browsers/ifs-browser.md)
- [Quick Start](/pages/tips/quickstart.md)
- [Tricks](/pages/tips/tricks.md)
- [Terminals](/pages/tips/terminals.md)
- [CCSID](/pages/tips/ccsid.md)
- [Setup](/pages/tips/setup.md)
- [Browsers](/pages/browsers/index.md)
- [User Library List](/pages/browsers/user-library-list.md)
- [Object Browser](/pages/browsers/object-browser.md)
- [IFS Browser](/pages/browsers/ifs-browser.md)
- Settings
- [Profiles](pages/settings/profiles.md)
- [Connection](pages/settings/connection.md)
- [Global](pages/settings/global.md)
- [Profiles](/pages/settings/profiles.md)
- [Connection](/pages/settings/connection.md)
- [Global](/pages/settings/global.md)
- Extensions
- [RPGLE language tools](pages/extensions/rpgle.md)
- [Db2 for i](pages/extensions/db2i.md)
- [Extending](pages/api/extending.md)
- [RPGLE language tools](/pages/extensions/rpgle.md)
- [Db2 for i](/pages/extensions/db2i.md)
- [Extending](/pages/api/extending.md)
Empty file added docs/fr-FR/.nojekyll
Empty file.
42 changes: 42 additions & 0 deletions docs/fr-FR/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Code for IBM i

## Développer sur l'IBM i avec VS Code

Maintenez et Compilez vos RPGLE, CL, COBOL, C/CPP sur l'IBM i depuis Visual Studio Code.

![intro_01.png](assets/intro_01.png)

## Prérequis

- Le Démon SSH doit être démarré sur l'IBM i.
- (Le programme sous license 5733-SC1 propose un support SSH.)
- `STRTCPSVR *SSHD` démarre le démon.
- L'utilisateur `QSSHD` est actif.
- Une connaissance de base des concepts de VS Code. Une introduction se trouve [içi](https://code.visualstudio.com/docs/getstarted/introvideos).

## Installation

Depuis la "Marketplace" de Visual Studio Code: [Code for IBM i](https://marketplace.visualstudio.com/items?itemName=HalcyonTechLtd.code-for-ibmi)

Ou via l'icône des Extensions dans la barre d'activité (à gauche) :
![assets/install_01,png](assets/install_01.png)

### Extensions recommandées

Il est recommandé d'installer également le [IBM i Development Pack](https://marketplace.visualstudio.com/items?itemName=HalcyonTechLtd.ibm-i-development-pack), Un ensemble d'extensions construites avec ou pour ajouter de la valeur à Code for IBM I. Cela inclut des outils pour la base de données, RPGLE, COBOL , et bien plus.

## Développement d'extension

1. cloner le dépôt
2. ```npm i```
3. 'Run extension' depuis le débogage de VS Code.

## Guide de démarrage

Pour travailler sur cette documentation:

- cloner le dépôt
- installer "docsify" ```npm i docsify-cli -g```
- lancer en local avec ```docsify serve docs/```
- par défaut, cela se lance sur http://localhost:3000
- Pour aller plus loin [Docsify](https://docsify.js.org/#/)
30 changes: 30 additions & 0 deletions docs/fr-FR/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
- [Code for IBM i](/fr-FR/)
- [Connexion](/fr-FR/pages/login.md)
- Développement
- [Édition et compilation](/fr-FR/pages/developing/editing-compiling.md)
- [Actions](/fr-FR/pages/developing/actions/index.md)
- [Execution](/fr-FR/pages/developing/actions/execution.md)
- [Variables personnalisées](/fr-FR/pages/developing/actions/custom-vars.md)
- [ILEDocs](/fr-FR/pages/developing/iledocs.md)
- Développement local
- [Pour Démarrer](/fr-FR/pages/developing/local/getting-started.md)
- [Structure de projet](/fr-FR/pages/developing/local/structure.md)
- [Azure DevOps](/fr-FR/pages/developing/local/azure.md)
- Astuces
- [Démarrage rapide](/fr-FR/pages/tips/quickstart.md)
- [Astuces](/fr-FR/pages/tips/tricks.md)
- [Terminaux](/fr-FR/pages/tips/terminals.md)
- [CCSID](/fr-FR/pages/tips/ccsid.md)
- [Configurer](/fr-FR/pages/tips/setup.md)
- [Explorateurs](/fr-FR/pages/browsers/index.md)
- [Liste des bibliothèques utilisateur](/fr-FR/pages/browsers/user-library-list.md)
- [Explorateur d'objet](/fr-FR/pages/browsers/object-browser.md)
- [Explorateur IFS](/fr-FR/pages/browsers/ifs-browser.md)
- Paramétrages
- [Profils](/fr-FR/pages/settings/profiles.md)
- [Connexions](/fr-FR/pages/settings/connection.md)
- [Généraux](/fr-FR/pages/settings/global.md)
- Extensions
- [RPGLE language tools](/fr-FR/pages/extensions/rpgle.md)
- [Db2 for i](/fr-FR/pages/extensions/db2i.md)
- [Créer une extension](/fr-FR/pages/api/extending.md)
Binary file added docs/fr-FR/assets/BrowserIFS_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/BrowserIFS_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_05.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_07.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_09.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Browser_10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Connect_Profile_Load_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Connect_Profile_Load_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Connect_Profile_Save_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/Connect_Profile_Setting_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-05.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-05A.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-07.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/fr-FR/assets/EditComp-09.png
Binary file added docs/fr-FR/assets/LogOutput_01.png
Binary file added docs/fr-FR/assets/LogOutput_02.png
Binary file added docs/fr-FR/assets/Snippet_01.png
Binary file added docs/fr-FR/assets/actions_01.png
Binary file added docs/fr-FR/assets/actions_02.png
Binary file added docs/fr-FR/assets/actions_custom_01.png
Binary file added docs/fr-FR/assets/actions_custom_01a.png
Binary file added docs/fr-FR/assets/actions_custom_02.png
Binary file added docs/fr-FR/assets/actions_custom_03.png
Binary file added docs/fr-FR/assets/actions_custom_04.png
Binary file added docs/fr-FR/assets/actions_exec_01.png
Binary file added docs/fr-FR/assets/actions_exec_02.png
Binary file added docs/fr-FR/assets/actions_exec_03.png
Binary file added docs/fr-FR/assets/actions_exec_04.png
Binary file added docs/fr-FR/assets/actions_exec_05.png
Binary file added docs/fr-FR/assets/actions_tool.png
Binary file added docs/fr-FR/assets/azure-1.png
Binary file added docs/fr-FR/assets/azure-2.png
Binary file added docs/fr-FR/assets/azure-3.png
Binary file added docs/fr-FR/assets/azure-4.png
Binary file added docs/fr-FR/assets/compare_01.png
Binary file added docs/fr-FR/assets/compile_04.png
Binary file added docs/fr-FR/assets/connect_01.png
Binary file added docs/fr-FR/assets/connect_02.png
Binary file added docs/fr-FR/assets/connect_03.png
Binary file added docs/fr-FR/assets/connect_04.png
Binary file added docs/fr-FR/assets/connect_05.png
Binary file added docs/fr-FR/assets/connect_06.png
Binary file added docs/fr-FR/assets/db2i.png
Binary file added docs/fr-FR/assets/db_01.png
Binary file added docs/fr-FR/assets/db_02.png
Binary file added docs/fr-FR/assets/db_03.png
Binary file added docs/fr-FR/assets/install_01.png
Binary file added docs/fr-FR/assets/intro_01.png
Binary file added docs/fr-FR/assets/intro_02.png
Binary file added docs/fr-FR/assets/local_1.png
Binary file added docs/fr-FR/assets/settings_01.png
12 changes: 12 additions & 0 deletions docs/fr-FR/media/as400.svg
Binary file added docs/fr-FR/media/icon.png
4 changes: 4 additions & 0 deletions docs/fr-FR/media/server.svg
74 changes: 74 additions & 0 deletions docs/fr-FR/pages/api/custom-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@

# Personnaliser une interface utilisateur dans Code For IBM i

Pour faciliter la création d'interface utilisateur, une commande `CustomUI` qui permet aux utilisateurs de définir les champs d'un formulaire et de gérer sa soumission via une fonction de rappel (callback).

* Chaque formulaire a besoin d'au moins 1 champ ou bouton de soumission.
* Vous devez `panel.dispose()` dans la fonction de rappel.
* et retourner `{panel, data}`

Vous pouvez trouver le source de cette API à `src/api/CustomUI.js`.

### La commande `code-for-ibmi.launchUI`

Votre extension peut exécuter cette commande comme ce qui suit:

```js
vscode.commands.executeCommand(`code-for-ibmi.launchUI`, `UI Tab`, fields, (result) => {
const {panel, data} = result;
if (data) {
// Button was pressed
panel.dispose();
} else {
// Tab was closed
}
});
```

### `Field` object

```js
/**
* {{
* id: string,
* type: "input"|"password"|"buttons"|"checkbox"|"file"|"tabs"|"tree"|"select"|"paragraph"|"hr",
* label: string,
* description?: string,
* items?: {label: string, value: string}[], // When type == tree
* items?: {selected?: boolean, value: string, text: string, description: string}[], // When type == select
* items?: {id: string, label: string}[], // When type == buttons,
* readonly? boolean // When type == input, allowing a readonly, non editable field.
* }[]}
**/
```

## Exemple

### Exemple simple

```js
const vscode = require(`vscode`);

context.subscriptions.push(
vscode.commands.registerCommand(`your-ext.runMyThing`, async function () {
const fields = [
{ type: `input`, id: `name`, label: `Your name` },
{ type: `buttons`, items: [{id: `connect`, label: `Connect`}] }
];

vscode.commands.executeCommand(`code-for-ibmi.launchUI`, `IBM i Login`, fields, (result) => {
const {panel, data} = result;
if (data) {
if (data.name.length > 0) {
panel.dispose(); //Must be called to close the panel!
vscode.window.showInformationMessage(`Hello ${data.name}!`);
} else {
vscode.window.showErrorMessage(`Name cannot be blank.`);
}
} else {
vscode.window.showInformationMessage(`Panel was closed by user.`);
}
});
});
);
```
Loading