Skip to content
This repository has been archived by the owner on Nov 9, 2017. It is now read-only.

Commit

Permalink
doc(glossary): update project glossary documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Eng committed Sep 20, 2016
1 parent 106e478 commit 9b22a48
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 41 deletions.
Binary file modified docs/images/project-view-versions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 12 additions & 7 deletions docs/user-guide/glossary/delete-glossaries.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
### Prerequisite
Requires **Glossary-admin** role. See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissions) for permission setup.
See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissions) for permission setup.

### Delete via Web UI
1. Login into Zanata
1. Click `Glossary` on menu.
1. To delete a glossary entry, go to the entry you wish to delete and click `Delete`.
1. To delete an entry in **system glossary**, click `Glossary` menu.
1. To delete an entry in **project glossary**, navigate to the project page, click on "Glossary" in the project page.
1. Go to the entry you wish to delete and click `Delete`.
<figure>
![Glossary edit](/images/glossary-edit.png)
</figure>


### Delete via Zanata Maven client
The following instructions assume that you have installed and configured the Zanata Maven Plugin.
### Delete via Zanata client
The following instructions assume that you have installed and configured the Zanata client.
Instructions for installation and configuration are available at [Installing Zanata client](http://docs.zanata.org/projects/zanata-client/en/latest/#installation).

**Delete all glossary entries in Zanata**
**Delete all system glossary entries**
```
zanata-cli glossary-delete --all
```

**Delete all project glossary entries**
```
mvn zanata:glossary-delete -Dzanata.allGlossary=true
zanata-cli glossary-delete --all --project {projectSlug}
```
28 changes: 3 additions & 25 deletions docs/user-guide/glossary/edit-glossaries.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
### Prerequisite
See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissions) for permission setup.

### Edit entries from Glossary page
1. Click `Glossary` menu.
1. To edit terms in **system glossary**, click `Glossary` menu.
1. To edit terms in **project glossary**, navigate to the project page, click on "Glossary" in the project page.
<figure>
![Glossary page](/images/glossary-page.png)
</figure>
Expand All @@ -18,26 +18,4 @@ See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissi
1. Fill in the translation, then to save it, click `Update`.
<figure>
![Glossary edit](/images/glossary-edit-trans.png)
</figure>


### Edit entries from editor

1. Go to editor in Zanata and select a string. Instructions for opening the
translation editor can be found at [Preparing for Translation](/user-guide/translator-guide#start-translate-a-project-version).
1. In Glossary panel (bottom right corner), click on <i class='i i--info txt--highlight'></i> icon on the glossary entry you wish to edit.
<figure>
![Glossary panel](/images/glossary-panel.png)
<figcaption>Glossary panel</figcaption>
</figure>
<br/>
<figure>
![glossary entry window](/images/glossary-edit-windows.png)
<figcaption>Glossary entry windows</figcaption>
</figure>

1. In the popup window, you can:
1. edit glossary target term
1. add/remove comments to target term - use `+` sign to add new comment, use `-` sign to remove comment from list

1. Click `Save` to save changes made in the glossary entry.
</figure>
38 changes: 35 additions & 3 deletions docs/user-guide/glossary/glossary-roles-permissions.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# System glossary

<p>
Glossary is used globally in all projects within Zanata. User assigned with these roles should understand the
The System glossary is used across all projects within Zanata. Users assigned with these roles should understand the
responsibility and effect when performing any of these actions.
</p>


There are 2 roles that manage glossaries in Zanata, **glossarist** and **glossary-admin**.
There are two roles that manage glossaries in Zanata, **glossarist** and **glossary-admin**.

User can request those roles by [contacting Zanata admin](/user-guide/admin/contact-admin).

Below are the summary of these 2 roles with their permission.
Below is the summary of the two roles with their permission.
<table>
<th>
<tr>
Expand All @@ -31,3 +33,33 @@ Below are the summary of these 2 roles with their permission.
<td style="text-align:center">&#10004;</td>
</tr>
</table>

# Project Glossary

A Project glossary is only available to the assigned project.

There are two roles that manage glossaries in project, **Project maintainer/Translation maintainer** and **Project translator**.

Below is the summary of the two roles with their permission.
<table>
<th>
<tr>
<td>**Roles**</td>
<td>[Upload glossary](/user-guide/glossary/upload-glossaries)</td>
<td>[Edit glossary](/user-guide/glossary/edit-glossaries)</td>
<td>[Delete glossary](/user-guide/glossary/delete-glossaries)</td>
</tr>
</th>
<tr>
<td>Project maintainer/Translation maintainer</td>
<td style="text-align:center">&#10004;</td>
<td style="text-align:center">&#10004;</td>
<td style="text-align:center">&#10004;</td>
</tr>
<tr>
<td>Project translator</td>
<td style="text-align:center">&#10004;</td>
<td style="text-align:center">&#10004;</td>
<td style="text-align:center">&#10006;</td>
</tr>
</table>
5 changes: 3 additions & 2 deletions docs/user-guide/glossary/insert-term.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
### Prerequisite
Requires **Glossary-admin** role. See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissions) for permission setup.
See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissions) for permission setup.

1. Login into Zanata
1. Click `Glossary` menu.
1. To insert a term into the **system glossary**, click `Glossary` menu.
1. To insert a term into the **project glossary**, navigate to the project page, click on "Glossary" in the project page.
1. Click on `New Term` on top right page.
<figure>
![new term](/images/glossary-new-term.png)
Expand Down
14 changes: 10 additions & 4 deletions docs/user-guide/glossary/upload-glossaries.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
### Prerequisite

See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissions) for permission setup.

### Supported file format
Expand Down Expand Up @@ -28,7 +27,8 @@ See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissi
### Upload via Web UI

1. Login into Zanata
1. Click `Glossary` menu.
1. To upload to the **system glossary**, click `Glossary` menu.
1. To upload to a **project glossary**, navigate to the project page, click on "Glossary" in the project page.
1. Click on `Import Glossary` on top right corner of the page.
<figure>
![More action in glossary page](/images/glossary-upload.png)
Expand All @@ -51,8 +51,14 @@ See [glossary roles and permission](/user-guide/glossary/glossary-roles-permissi

The following instructions assume that you have installed and configured the Zanata Client. Instructions for installation and configuration are available at [Zanata Client Installation](http://docs.zanata.org/projects/zanata-client/en/latest/#installation).

Command
**System glossary**

```
zanata-cli glossary-push --file {filename} --trans-lang {translation locale}
```

**Project glossary**

```
mvn zanata:glossary-push -Dzanata.glossaryFile={filename} -Dzanata.sourceLang={source locale} -Dzanata.transLang={translation locale}
zanata-cli glossary-push --file {filename} --trans-lang {translation locale} --project {projectSlug}
```
3 changes: 3 additions & 0 deletions docs/user-guide/projects/project-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ When a project is selected, you will be taken to an overall view of the project.

The different views for a project offer more information about it.

- **Versions** shows all versions for the project
- **People** shows the project Maintainers, Translators and Reviewers.
- **Glossary** shows glossary entries for the project.
- **About** shows more information about the project.
- **Settings** _(This is only available to Project Maintainers)_ allows the user to change project settings.


To [view the information about a specific version](/user-guide/versions/version-view), you can click on the version's name from the list.

0 comments on commit 9b22a48

Please sign in to comment.