Skip to content

OJSBR/shariff

Repository files navigation

Shariff — OJS/OMP plugin (OJSBR build with Portuguese translations)

OJS Version License

⬇️ Install package: OJS/OMP 3.5 — or browse all Releases.

The Shariff plugin adds social media buttons to OJS/OMP without compromising the privacy of website users, using the Shariff solution by heise online. For the full feature and configuration documentation, see the original README-upstream.md.

⚠️ Unofficial build. This repository is maintained by OJSBR only while the Portuguese fixes below are pending upstream. It is the official ojsde/shariff stable-3_5_0 code plus the three commits sent in ojsde/shariff#54 — nothing else. Once the PR is merged and released, use the official plugin.

What this build changes

# Change Why
1 Adds locale/pt_BR/locale.po (complete, 55 keys) The Brazilian Portuguese translation shipped in 3.3.1 was renamed to pt_PT in 3.4 and to pt in 3.5. OJS treats pt (Portugal) and pt_BR (Brazil) as different locales and never falls back between them, so journals running pt_BR got no translation at all.
2 Completes and fixes locale/pt/locale.po 11 keys were missing compared to en, and 3 obsolete publicationLink* keys had been renamed to publicationSharingLink* in the code — those labels were broken in the settings form. Wording adjusted to European Portuguese.
3 Passes an ISO 639-1 code in data-lang Shariff only knows two-letter language codes (langFallback: "en"), so pt_BR, fr_CA, es_MX, zh_Hans, … fell back to English button labels. Now LocaleConversion::getIso1FromLocale() is used in ShariffPlugin.php and ShariffBlockPlugin.php.

The plugin release number was bumped from 3.5.1.1 to 3.5.1.2 so that OJS accepts the upload on top of an existing official install. No other file was touched.

Compatibility & branches

PKP version Branch Plugin release Upstream base
OJS/OMP 3.5.x stable-3_5_0 (default) 3.5.1.2 ojsde/shariff@140b457 (3.5.1.1)

Running 3.4 or earlier? Use the official repository: ojsde/shariff. Note that the pt_PT folder there carries the same gaps described above.

Installation

  1. Install via Settings → Website → Plugins → Upload A New Plugin, or extract the folder into plugins/generic/ so you get plugins/generic/shariff/.
  2. Enable Shariff Plugin under the Generic plugins list.
  3. Configure it in Settings → Website → Appearance → Shariff: services, theme, position (footer, sidebar or publication page), orientation and the sharing link (page URL or DOI URL).

To display share counters you also need the Shariff PHP backend in a shariff-backend folder at the document root — see the upstream documentation.

Credits & authorship

The Shariff plugin is developed by Universitätsbibliothek Freie Universität Berlin / OJS-de.net — see ojsde/shariff. The bundled Shariff library (v3.3.1) is by heise online (MIT License). OJSBR only contributed the Portuguese translations and the language-code fix, all of which were submitted upstream. Distributed under the GNU GPL v3 — see LICENSE.

Keeping in sync

There is no local patch to maintain: watch ojsde/shariff#54 and the upstream repository, and retire this build as soon as the changes land in an official release.

About

Shariff plugin for OJS/OMP 3.5 — unofficial OJSBR build of ojsde/shariff with the Portuguese fixes proposed in ojsde/shariff#54 (adds pt_BR, completes pt, fixes data-lang). Maintained until the official release. · Plugin Shariff para OJS/OMP 3.5 — build nao-oficial da OJSBR com as correcoes de portugues propostas no PR ojsde/shariff#54.

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages