Skip to content
Draft
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
9 changes: 5 additions & 4 deletions docs/wiki/HOME-‐-SciELO-Publishing-Platform-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ _Update: Technology team, 9-Apr-2025_
#### Web site (opac) administration

- [About management](https://github.com/scieloorg/opac_5/wiki/About-management)
- [Gestão de Internacionalização](https://github.com/scieloorg/opac_5/wiki/Gestão-de-Internacionalização)
- [Gestão de Notícias](https://github.com/scieloorg/opac_5/wiki/Gestão-de-Notícias)
- [Gestão do Logo](https://github.com/scieloorg/opac_5/wiki/Gestão-do-Logo)
- [Mudança de logo do website](https://github.com/scieloorg/opac_5/wiki/Procedimento-de-mudan%C3%A7a-do-logo-do-site)
- [Internationalization management](https://github.com/scieloorg/opac_5/wiki/Internationalization-management)
- [News management](https://github.com/scieloorg/opac_5/wiki/News-management)
- [Logo management](https://github.com/scieloorg/opac_5/wiki/Logo-management)
- [Website logo change procedure](https://github.com/scieloorg/opac_5/wiki/Website-logo-change-procedure)
- [How to create a Sponsor and link it to a collection](https://github.com/scieloorg/opac_5/wiki/How-to-create-a-Sponsor-and-link-it-to-a-collection)

#### Upload application administration

Expand Down
49 changes: 49 additions & 0 deletions docs/wiki/How-to-create-a-Sponsor-and-link-it-to-a-collection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
### How to create a Sponsor and link it to a collection

Below is a step-by-step guide for creating a **Sponsor** and assigning it to the **Sponsors** field of a **Collection**.

---

### 1. Upload the sponsor image

Access the administrative area at `/admin`

1. In the **navbar**, go to: **Assets > Image**
2. Click **Create**.
3. Fill in the fields:
- **Name**: enter an identifiable name for the image (e.g., `sponsor_x_logo`).
- **File**: select the sponsor's logo file from your computer.
- **Image language**: choose the corresponding language (if applicable to your context).
4. Click **Save**.

After saving:

5. A table with the registered images will be displayed.
6. In the **Link** column, copy the **image URL**.
- Keep this URL, as it will be used when creating the sponsor.

---

### 2. Create the Sponsor in the Catalog

1. In the **navbar**, go to: **Catalog > Sponsor**
2. Click **Create**.
3. Fill in the fields:
- **Sponsor name**: enter the official name of the sponsor.
- **Website URL**: enter the sponsor's website address (e.g., `https://www.example.com`).
- **Logo URL**: paste the **image URL** copied earlier, from the Assets > Image step.
4. Click **Save**.

The sponsor will now be available to be associated with collections.

---

### 3. Link the sponsor to the collection (Sponsors field)

1. In the **navbar**, go to: **Catalog > Collections**
2. Locate your **main collection**.
3. On the collection's row, click the edit icon (**pencil** icon).
4. In the collection edit form, locate the **Sponsors** field.
5. In the **Sponsors** field, select the previously created sponsor.
- You can add more than one sponsor.
6. Click **Save** to confirm the collection changes.
161 changes: 161 additions & 0 deletions docs/wiki/Internationalization-management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
_Update: Development team, 8-Oct-2024_

### Introduction

This guide explains how to generate files with translatable terms and how to complete them with translations.

### Preparation

Obtain a copy of the project from GitHub by running the following command:

```
git clone git@github.com:scieloorg/opac_5.git
```

### How to create files with translatable terms

Run the following command:

```
export LANG=pt && make create_catalog
```

The result of this command is the creation of a new file in the _translations_ folder:

![Screenshot 2024-08-05 at 16 38 50](https://github.com/user-attachments/assets/c882c03a-2297-4b81-aa3b-24549380c0f3)

### How to update files with translatable terms

Run the following command:

```
make update_catalog
```

The result of this command is the creation or update of the .po files:

![Screenshot 2024-08-05 at 16 40 40](https://github.com/user-attachments/assets/e632dbc1-aeae-4049-b72b-be5b0983be24)

### The .po files (translation files)

These files follow the pattern below:

#### Header

```
# FIRST AUTHOR <email@address>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: Transifex\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2018-03-29 12:41+0000\n"
"PO-Revision-Date: 2018-03-29 12:43+0000\n"
"Last-Translator: Transifex\n"
"Language-Team: English (https://app.transifex.com/transifex/transifex/language/en/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Language: en\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
```

#### Body

A sequence of original terms (msgid) and translations (msgstr):

```
#: actionlog/templates/object_action_list.html:7 txpermissions/forms.py:18
msgid "User"
msgstr ""

#: actionlog/templates/object_action_list.html:8
msgid "Action"
msgstr ""
```

### How to compile files with translated terms

Run the following command:

```
make compile_messages
```

This compiles the translations from .po files into .mo files ready for use.

Result of this command:

![Screenshot 2024-08-05 at 16 44 32](https://github.com/user-attachments/assets/5c8f4df0-9117-4fb9-8ef4-2d2e5fb7da81)

### How to complete the translations

The files to be edited are messages.po. You can edit the translation files in any text editor.

They are located at [https://github.com/scieloorg/opac_5/tree/master/opac/webapp/translations](https://github.com/scieloorg/opac_5/tree/master/opac/webapp/translations), in folders named after their respective languages ("en", "es", "es_MX", "es_ES", "pt_BR").

The `msgstr ""` lines should be completed with the respective translation. For example:

**Before**

```
#: actionlog/templates/object_action_list.html:7 txpermissions/forms.py:18
msgid "User"
msgstr ""

#: actionlog/templates/object_action_list.html:8
msgid "Action"
msgstr ""
```

**After**

```
#: actionlog/templates/object_action_list.html:7 txpermissions/forms.py:18
msgid "User"
msgstr "Usuário"

#: actionlog/templates/object_action_list.html:8
msgid "Action"
msgstr "Ação"
```

### How to update translations in the project

After completing the translation, open a Pull Request with the changes to the project.

### How to add a new language to the interface

After completing all the procedures for creating translation files, you can enable a new language in the interface by adding a new entry to the environment variable file _.flask_:

Default definition of the .flask file for the OPAC_LANGUAGES variable:

```
OPAC_LANGUAGES="{'pt_BR': 'Português','en': 'English','es': 'Español'}"
```

To add a new language that already has its translations, you need to modify this variable. For example, to add Italian:

```
OPAC_LANGUAGES="{'pt_BR': 'Português','en': 'English','es': 'Español', 'it': 'Italian'}"
```

### How to contribute without using git

This procedure is recommended for those who only want to perform the translation, while the incorporation procedures are the responsibility of the SciELO development team.

Access the folder [https://github.com/scieloorg/opac_5/tree/master/opac/webapp/translations](https://github.com/scieloorg/opac_5/tree/master/opac/webapp/translations) through GitHub and copy the .po file. See the image below for how to download this file:

![Screenshot 2024-08-16 at 07 32 10](https://github.com/user-attachments/assets/77c854f6-7ed2-4281-9e81-29cb4d3be8b6)

If the files do not exist, send an email requesting the files for a new language.

To edit the file directly on GitHub, you need a GitHub account. See the link with instructions to create an account: [https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github)

You can edit the file by clicking the edit link as shown in the image:

![Screenshot 2024-08-19 at 07 28 07](https://github.com/user-attachments/assets/9d550398-a5c3-4790-83d9-0abc31a31906)

Perform the translation of the .po file.

After completing the translation, send an email requesting the incorporation of the translation.
37 changes: 37 additions & 0 deletions docs/wiki/Logo-management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
_Update: Development team, 05-Aug-2024_

The website will always display the SciELO logo:

![Screenshot 2024-08-05 at 17 27 18](https://github.com/user-attachments/assets/8d9b582b-7c0f-4294-9c3a-c340d1755a99)

The name "Brazil" is the collection name that is registered in the administrative area, on the following screen:

![Screenshot 2024-08-05 at 17 29 35](https://github.com/user-attachments/assets/c6667782-99a2-40fa-a44b-bc0f18ab75c9)

To change the logo, follow the steps below:

1. **Upload the Logo Image:**

- Access the "Static files" > "Image" link in the admin area:

![Screenshot 2024-08-05 at 17 43 37](https://github.com/user-attachments/assets/a4750dcc-f26c-4f1b-9447-5bd336b00f4a)

- Click "Create" to create a new record:

![Screenshot 2024-08-05 at 17 44 05](https://github.com/user-attachments/assets/dfa9ce10-661c-4d87-9816-711a01ce364a)

- After creating a new record, obtain the image path by clicking on the "link" column to get the image link:

![Screenshot 2024-08-05 at 17 45 42](https://github.com/user-attachments/assets/3e5dad68-0053-4333-a039-25cc70c99638)

Important: It is possible to have one image per language.

2. **Modify the Collection Record:**

- To change the logo, modify the collection record:

![Screenshot 2024-08-05 at 17 47 50](https://github.com/user-attachments/assets/a019a5b4-5ff4-4d06-8728-ac688a070636)

- It is possible to change the logo per language, as illustrated below:

![Screenshot 2024-08-05 at 17 48 19](https://github.com/user-attachments/assets/4f9aa53b-7a77-457a-9ac5-ae0a74272ce7)
11 changes: 11 additions & 0 deletions docs/wiki/News-management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
_Update: Development team, 05-Aug-2024_

To display news on the website, it is necessary to configure a data source that provides an **RSS** format. RSS (Really Simple Syndication) is a type of _feed_ that allows automated aggregation of updated content. With a configured RSS data source, the website can fetch and display the latest news without the need for manual input.

Within the website's administrative area, the content of these news items can be viewed through the "News" link in the menu:

![Screenshot 2024-08-05 at 17 10 12](https://github.com/user-attachments/assets/04d43ced-168f-4d73-9ffa-bece6959ab5f)

After configuring and registering the RSS data source, the news list will be displayed as follows:

![Screenshot 2024-08-05 at 16 59 24](https://github.com/user-attachments/assets/42364165-5e7f-4a9b-bef3-f2e244bf39d5)
7 changes: 7 additions & 0 deletions docs/wiki/Website-logo-change-procedure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
_Update: Development team, 08-Feb-2024_

Access the administrative area.

Add the link for the new logo; otherwise, leave it blank and the default logo will be used.

![Screenshot 2024-02-08 at 11 44 12](https://github.com/user-attachments/assets/352caa06-1f70-4572-aa4c-0ed96c4092ea)