Skip to content

bugfishtm/sf-lg-language

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

πŸ“¦ Language Module Example

πŸ“™ Introduction

This example Language Module demonstrates the functioning of Language Module extensions within this CMS. Its explaining the use of various folders and provides a skeleton template for creating your own Language modules.

You may download the example module here: Download

  • Language modules can override language key values of the Suitefish CMS Administrator module by defining overrides within language.php.
  • Multiple language modules can be active simultaneously, with the option to select from the available languages.

πŸ› οΈ Installation

  1. Method: Login to your suitefish instance and browse our official store on your page. If you find the module you are looking for just download the package. Then navigate to the Language Package Area and enable the downloaded Language.

  2. Method: Navigate to the Language Package Area inside the Suitefish instance. Go to the upload section and upload the modules .zip file. Then navigate to the Language Package Area and enable the downloaded Language.

πŸ“ Folder Structure

Folder/File Description Optional
./_changes/ Folder for Changelogs Optional
./_changes/index.php Prevent Directory Listing Optional
./_changes/1.10.100.php Changelog for version 1.10.100 Optional
./_lang Store your language files in this folder Optional
./_lang/de.php Translation File for German Optional
./_lang/en.php Translation File for English Optional
./_lang/es.php Translation File for Spanish Optional
./_lang/fr.php Translation File for French Optional
./_lang/in.php Translation File for Hindu Optional
./_lang/it.php Translation File for Italian Optional
./_lang/ja.php Translation File for Japanese Optional
./_lang/kr.php Translation File for Korean Optional
./_lang/pt.php Translation File for Portuguese Optional
./_lang/ru.php Translation File for Russian Optional
./_lang/tr.php Translation File for Turkish Optional
./_lang/zh.php Translation File for Chinese Optional
./_lang/[LANGEUAGECODE].php Other language Files you may add Optional
./_lang/index.php Prevent Directory Listing Optional
./_licenses Store your external licenses in this folder Optional
./_licenses/example.lic Example License File Optional
./_licenses/[LIBNAME].lic Store your other License files here Optional
./_licenses/index.php Prevent Directory Listing Optional
./preview.jpg Preview image for the store and other areas the module is visble at Mandatory
./LICENSE.md License information about the module Mandatory
./README.md Readme file with general information about the module Mandatory
./version.php Versioning and meta file of the module Mandatory
./index.php Prevent Directory Listing Optional
./language.php Main language file for suitefish administrator module overrides. Mandatory

πŸ“ Developer Insights

This section provides important information for developers about module development, including essential coding guidelines to be followed prior to submitting or deploying modules.

πŸ“‹ Code Guidelines

Please follow these coding guidelines when developing modules:

  • The module's Rname identifier must be unique.
  • If you plan to publicly release your module, request a unique Rname from the Suitefish staff. Otherwise, prefix your module's Rname with "int" to designate it as an internal, non-public module, avoiding duplication.
  • Public image modules should have an Rname starting with "lg".
  • Ensure the Rname does not exceed 20 characters.
  • Avoid using special characters in the Rname, as they may cause critical errors.

πŸ—ƒοΈ language.php

You can override any language keys function by defining your own in this file. See available language keys in ./_site/_administrator/_lang/en.php or through other theme modules. The language library loads only after the Suitefish CMS frontpage initializes, making all documented site module variables and constants available.

πŸ“š Language Files

Language files in this type of module are used only to display the name and description in the store for multilingual support. Below is an example of an English language file (en.php). The initial lines restrict public access to the file. The translation variables enable the store to present the name and description in multiple languages. The main language file for the administrator interface is language.php.

<?php if(isset($this)) { if(!is_object($this)) { Header("Location: ../"); exit(); } } else { Header("Location: ../"); exit(); } ?>

store_version_name=Template: Theme Module
store_version_description=This example Theme demonstrates the functioning of Theme Module extensions within this CMS. It includes readme files explaining the use of various folders and provides a skeleton template for creating your own Theme modules.

πŸ“ Changelog File

Changelog of changes between this and last version of this module. Store the changelog in simple html format in the $x variable in files fitting the version number at _changes.

$x = "<b>Release 1.10.100</b><br /> - Initial Release";

🏷️ Version File

This file (version.php) contains detailed information about the module, all variables are mandatory and should be set on a module.

Variable Description Example / Notes
Module Variables and Informations - -
$x["rname"] Unique module identifier. "_language"; max 15 chars, no special chars or numbers; start with "xxx" if not registered.
Contact suitefish staff to register for official public store ID. Underscore prefix reserved for Suitefish official releases.
$x["lang"] Supported languages expressed as short codes in a PHP array. This is also the shortcode for the language to be installed like en_GB or de_DE. array("en)
$x["build"] Build number (integer only). "100"; used for version extensions and database updates.
$x["version"] Full module version, including main and build numbers. "1.10.100" (example uses build number appended).
$x["name"] Module name displayed on front-end areas. Plain text only, no HTML allowed. "Template: Language Module"
$x["description"] Module description shown on front-end areas. Allows simple HTML tags (br, li, table). "Suitefish CMS language template for developers..."
No scripts, styles, or complex tags allowed. Mandatory field.
$x["type"] Module type identifier (1 - Site 2 - Extension 3 - Image 4 - Windows 5 - Docker 6 - Theme 7 - Language 8 - Library). 7 (for theme modules)
$x["custom_update_server"] Custom Update Server URL for this Module, if not the official Update Server. https://update_server
$x["cms_version_min"] Minimum Suitefish CMS version required for this module. "7.10.100"
$x["dependencies"] Module dependencies for module or false. Enter module name dependencies in simple array format.
$x["parent_rname"] Only for developers developing own site modules, who wanna copy or use or module functionality Module name of parent module, false for suitefish default module.
Module Author Specific Settings - -
$x["license"] Module license identifier (e.g., gplv3, mit, bsd). Can be set to false if none.
$x["author"] Name of module author. "Suitefish"; can be false.
$x["mail"] Email address of the module author. false if not provided.
$x["website"] Website URL of the module or author. false if not provided.
$x["documentation"] URL to module documentation. "https://bugfishtm.github.io/suitefish-cms/"
$x["github"] GitHub repository URL for the module. "https://github.com/bugfishtm/suitefish-cms"
$x["video"] Video URL related to the module (optional). false if none.

πŸ“„ Documentation

If you are a developer you can find examples of modules in the _developers folder at the suitefish-cms github repository if you want to create an own module! For more information about the Suitefish CMS: https://github.com/bugfishtm/suitefish-cms.

🐟 Bugfish

About

🐬 Suitefish πŸš€ Developer (example) and debugging theme modules.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Contributors