Skip to content

Commit

Permalink
Dev docs links (#1252)
Browse files Browse the repository at this point in the history
* Update architecture-database.md

* Update architecture-routes.md

* Update utilities-translation.md

* Update architecture-authentication.md

* Update frontend-controllers.md
  • Loading branch information
kaitlinnewson authored Oct 3, 2024
1 parent 04b6c0d commit 48c9b29
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions dev/documentation/en/architecture-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ CSRF tokens must be sent with all `POST`, `PUT` or `DELETE` requests to prevent
$csrfToken = $request->getSession()->getCSRFToken();
```

CSRF tokens are not required for requests to the API when the [API Token](/dev/api/#api-token) is used.
CSRF tokens are not required for requests to the API when the [API Token](/dev/api/ojs/3.4#tag/Authentication/API-Token) is used.

### Page Routes

Expand Down Expand Up @@ -72,7 +72,7 @@ API Handlers automatically check the CSRF token for all `POST`, `PUT` or `DELETE

## UI Library

A CSRF token is available as a global variable when working with the UI Library. Learn more about using the [CSRF Token](/dev/ui-library/dev/#/pages/csrf) in ajax requests.
A CSRF token is available as a global variable when working with the UI Library. Learn more about using the [CSRF Token](/dev/ui-library/dev/#/pages/api#csrf-token) in ajax requests.

## User Session
The user's session stores a logged-in user's IP address, last-used date/time and more. You can access the current user's session directly.
Expand All @@ -92,4 +92,4 @@ The [Handlers](./architecture-handlers) should perform any authentication and au

---

Now that we know who the user is, learn [how we authorize their access to different operations](./architecture-authorization).
Now that we know who the user is, learn [how we authorize their access to different operations](./architecture-authorization).
2 changes: 1 addition & 1 deletion dev/documentation/en/architecture-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ mysql> select * from journal_settings where journal_id=1 and setting_name='keywo
+------------+--------+--------------+---------------+--------------+
```

Properties in an entity's [schema](./architecture-entities#schemas) that are an array or object are serialized to JSON when they are stored in the settings table.
Properties in an entity's [schema](./architecture-entities#schema) that are an array or object are serialized to JSON when they are stored in the settings table.

```
mysql> select * from journal_settings where journal_id=1 and setting_name='supportedLocales';
Expand Down
2 changes: 1 addition & 1 deletion dev/documentation/en/architecture-routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The router will **not** find a file at `/lib/pkp/api/v1/submissions/index.php`.

## Controller Routes

The diagram below shows a URL for a [Controller Handler](architecture-handlers#controller-handlers).
The diagram below shows a URL for a [Controller Handler](architecture-handlers#controller-handlers-deprecated).

![Diagram indicating the parts of a URL for Controller Handlers](../img/url-route-controller.png)

Expand Down
4 changes: 2 additions & 2 deletions dev/documentation/en/frontend-controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ class PKPReviewerGridHandler extends GridHandler
}
```

Finally, the grid must define a `loadData` method that gets the items to be displayed. It should return an `array` of [DataObjects](./architecture-entities#dataobject-class).
Finally, the grid must define a `loadData` method that gets the items to be displayed. It should return an `array` of [DataObjects](./architecture-entities#dataobject).

```php
use APP\core\Request;
Expand Down Expand Up @@ -357,7 +357,7 @@ Every action created by the grid handler or the grid row will require an operati

Most controllers are used to display a `Form`, which displays the form, receives the form submission, validates the input, and executes the changes.

> The forms described here are used by Controllers which have been deprecated. Use the forms in the [UI Library](./frontend-components#forms) when building forms for new features.
> The forms described here are used by Controllers which have been deprecated. Use the forms in the [UI Library](/dev/ui-library/3.4/#/component/Form) when building forms for new features.
{:.warning}

Every form extends the `Form` class. Define the template to use to render the form and add validation checks in the constructor method.
Expand Down
4 changes: 2 additions & 2 deletions dev/documentation/en/utilities-translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Translation - Technical Documentation - OJS|OMP|OPS

PKP's applications support multilingual publishing. This means the application can be translated into any language. It also means that each journal, press or preprint server can publish material in more than one language. This chapter will describe how to use translations and work with multilingual data.

> This guide describes how to work with translations when coding for PKP applications. Visit the [translating guide](./translating) to create or edit a translation of PKP software.
> This guide describes how to work with translations when coding for PKP applications. Visit the [translating guide](/translating-guide/) to create or edit a translation of PKP software.
{:.notice}

## Translations
Expand Down Expand Up @@ -132,7 +132,7 @@ msgstr[2] "%d Komentarzy"

A journal, press or preprint server may publish in more than one language. For that reason, all data objects and forms must accept content in more than one language.

> The Entities chapter describes how to [get multilingual data in the DataObject class](/dev/documentation/en/architecture-entities#dataobject-class) and how to [define multilingual properties in the schema](/dev/documentation/en/architecture-entities#multilingual).
> The Entities chapter describes how to [get multilingual data in the DataObject class](/dev/documentation/en/architecture-entities#dataobject) and how to [define multilingual properties in the schema](/dev/documentation/en/architecture-entities#schema).
{:.notice}

Each journal, press, or preprint server can enable a locale in the UI, forms and submissions.
Expand Down

0 comments on commit 48c9b29

Please sign in to comment.