Projects:Javascript Spanish names/Development Status
Javascript Spanish names - Development Status
The Javascript Spanish names project aims to translate the Spanish parts of the Javascript code to English. After it's finished all code and comments have to be in English only.
Javascript code is contained in three different locations:
- Most of the code is contained in the web/js-folder.
- Some more code is contained in the html-templates.
- At least some of the Javascript code (function calls and variable declarations) is embedded into java-code (i.e. WAD and Callouts).
The needed code-changes can be grouped into a small number of categories:
- function-parameters and local variables
- function-names
- global variables
- external variables (global variables not defined defined in the same file, but used in some function)
Renaming any of these has different impact based on the category:
- function-parameters and local variables: The impact of changing these is very limited. Only the function surrounding these declaration has to be modified. No external code needs to be changed, so no wrappers with the old names are needed.
- function-names: These are possibly called from different files and from customized code. So when renaming any functions to an English name a new wrapper-function with the old name with be created which just forwards to the renamed function. This wrapper allows custom code to work and gives some time to migrate to renamed functions. This wrapper function will be marked deprecated at once and can be removed later on. The code inside the standard code base will be modified within this project.
- global-variables: The impact when changing these is not located to one function. These variables are accessible in all html templates which include the defining javascript-file. When renaming these, a search through the code base is needed to find all places where these are used.
- external variables: These have to be renamed in unison in all callers of the function and inside the called function itself. In that aspect they are similar to global variables.