Documentation Update

Details

In this new update on documentation, I created a changelog section to higlight the new change(s) on the script. I also explained how the new multi-language feature works, so developers can know how to work around it, I also explained how translators can contribute to the project following laid down standards and also gave a simple but comprehensive 'how-to' for them to add new translations. Since I am the author of the project, every change was committed directly to master.

below are links to the new commits:
https://github.com/Akintunde102/Yoruba/commit/5279c1f36aac365acd325f88449342aa3fd2129d
https://github.com/Akintunde102/Yoruba/commit/f1895faf84c4788635525727782218991fea570d

Components

The documentation contains the following components:

• Short Summary
• Description
• How it works
• List of Pages and How they work
• List of folders and description of content
• How to contribute new translations
• How Translation Works
• Initial Version
• Present Version
• changelog
• Contact me
• Screenshots

Diff

• List of Pages and How they work
  I updated this section to add the new file that controls and detect user's language choice and then explain how it works.
  Excerpt

Language Processing File (lang_process.php)
This file processes user's language choice and then save it as a cookie and then include the choosen language file from the /lang/ folder through php include

• List of folders and description of content
  I also updated this section to explain a new folder (/lang/) I added as it contains language translations for the script. I also added a description of it there.
  Excerpt

lang: This folder contains language translation files

• How to Contribute New Translations
  I created this section for the first time to explain how the translators can contribute to the project without breaking things. It is simple and comprehensive
  Excerpt

With the version 2.0, new translations can now be added without need to understand how to code. Below are the procedures.

Got to the /lang/ folder
Copy the contents of the language file you want to translate from
Then create your new language file and name it using the stated naming convention of other language files in the folder For instance, to convert from english to french, you would have copy the contents of lang.en.php to a newly created file you would name lang.fr.php.
Then change every variable content in the file to the new language as shown in the instance: for instance, $lang['SLIDER1'] = Yoruba Dancers Displaying On stage'; would become Yoruba Dancers Affichage sur scène for an English to French translation.
take note, that every language has certain codes that needs to be rightly inputed in the naming convention. Some of this naming conventions can be found here. Any code not listed here can be created by discretion.

• How Translation Works
  I also newly created this section to explain to the user how the translation system technique works

Excerpt

How Translation Works
Every translation version of the site can be called by appending the language code after a slash like this example.com/en, after thsis subsequent site pages don't need the appedning as the sote has been saved as a cookie
the lang_process.php controls the detection and saving of language codes through the use of cookie translations are saved in the/lang/` folder.

• Present Version
  I newly created this section because the Intial version is no longer the present version.
  
  
  Excerpt

Present Version: 2.0

• Changelog
  I also newly created this section because this is the first time new changes and features are being added to the source codes since version 1.0
  
  
  Excerpt

Changelog: 2.0: Addition of Multi-Language Support

Links

New Documentation: https://github.com/Akintunde102/Yoruba/blob/master/README.md

---

Posted on Utopian.io - Rewarding Open Source Contributors

---