Skip to content

Latest commit

 

History

History
109 lines (85 loc) · 2.33 KB

pluginDocumentation_customLocale.md

File metadata and controls

109 lines (85 loc) · 2.33 KB

Key data

  • name of the plugin: Custom Locale Plugin
  • author: Carola Fanselow
  • current version: 1.0.0.0
  • tested on OMP version: 1.2.0
  • github link: https://github.com/langsci/customLocale.git
  • community plugin: yes
  • date: 2016/05/21

Description

This plugin allows to customize locales via the OMP GUI. The default locales are replaced but not overwritten and can easiliy be restored. A simple documentation can be printed that lists all changes made to the locales. The locales can be customized in the tab 'locale' in management > settings > website. There is a search function for files and for locale keys within the files. The documentation can be printed in the plugin's settings section.

Implementation

Hooks

  • used hooks: 4

      PKPLocale::registerLocaleFile
  LoadComponentHandler
  Templates::Management::Settings::website
  LoadHandler

New pages

  • new pages: 1

      management/settings/website, tab 'Locales'

Templates

  • templates that substitute other templates: 0

  • templates that are modified with template hooks: 0

  • new/additional templates: 3

      customLocale.tpl
  customLocaleGridFilter.tpl
  localeFile.tpl

Database access, server access

  • reading access to OMP tables: 0

  • writing access to OMP tables: 0

  • new tables: 0

  • nonrecurring server access: no

  • recurring server access: yes

      creating, reading from and writing to files in public/presses/%pressId%

Classes, plugins, external software

  • OMP classes used (php): 19

      GenericPlugin
  FileManager
  Handler
  GridHandler
  RecursiveDirectoryIterator
  RecursiveIteratorIterator
  RegexIterator
  DataObject
  GridCellProvider
  AjaxModal
  EditableLocaleFile
  LocaleFileForm
  JSONMessage
  GridColumn
  PagingFeature
  LinkAction
  RedirectAction
  Form
  TemplateManager

  • OMP classes used (js, jqeury, ajax): 0

      ClientFormHandler
  AjaxFormHandler

  • necessary plugins: 0

  • optional plugins: 0

  • use of external software: no

  • file upload: no

Metrics

  • number of files: 19
  • lines of code: 1668

Settings

  • settings: no

Plugin category

  • plugin category: generic

Other

  • does using the plugin require special (background)-knowledge?: no
  • access restrictions: restricted to admins and press managers
  • adds css: yes