Difference between revisions of "Easy Edit Generator"

From TNG_Wiki
Jump to: navigation, search
(added to category Mods for TNG v12)
 
Line 186: Line 186:
  
 
|}
 
|}
 +
 +
 +
[[Category:Mods for TNG v12]]

Latest revision as of 20:24, 16 November 2019

Restricted Downloads of Easy Edit Generator are restricted to logged in users. If you do not have a user account on the TNG Wiki use the Request Account link to request a user account Restricted


Easy Edit Generator (EEGen)
Summary Generates an Easy Edit file for mods using many parameters.
Validation
Mod Updated 16 nov 2019
Download link for
TNG 12.0

Easy_Edit_v 12.0.2.1e
Download stats Montrer les statistiques
Author(s) Michel Kirsch
Homepage Racines luxo-hennuyeres
Mod Support TNG Community Forums
Contact Developer MyMail
Latest Mod 12.0.2.1e for TNG v12
Min TNG V n.c
Max TNG V 12+
Files modified
Related Mods
Notes



Purpose of the Mod

This mod installs a generator program which generate files which permits an easy edit of the parameters of a given mod.
The easy edit parameters file generated can be attached to the mod to givez the user of the mod an "user friendly" parameters screen.
If he is administrator of his TNG site, the user can generate himself his "Easy Edit" files for his installed mods.

Thanks to

Development

Writted by : MichelKirsch from Charleroi - Hainaut - Belgium

Requirements

A TNG 12.0.2+ installation in working order.
This program was tested with the mods OpenStreetMap, Living Color Mod, Balanced Media, [Living Color], [Open Street Map] and [Sosa].
ATTENTION: It will not works with mods having parameters in more than one file, as example the mods [Show All Family] or [Add Person Siblings Row].

This program works certainly with many others mods. Thanks to keep me informed or update this list of mods.

Before installation

No special precautions are required before installing the program.

INSTALLATION

'Unzi'p the received file directly in the mods sub-folder of your TNG installation folder.
Via Mod Manager, install the Mod.
Once the program installed, it can be runned by clicking on the [Run - Démarrer] button in the description of the mod.

ATTENTION If you want to generate "Easy Edit" files for a mod, this mod MUST be installed BEFORE the generation of the files !!

Ecran d'installation

UNinstalling

Uninstalling the program doesn't delete the "Easy Edit" files you have generated. Those files must be deleted if necessary BEFORE uninstall the program  !! Prior to delete files, be sure that you have restored the default values of the mod via the "Easy Edit" you generated.

Update

When pdating near a earliest version.

  • Uninstall then suppress the actual Mod.
  • Proceed as a normal installation for the new version.

In the event of a problem

  • Try using the Mod Manager Remove capability
  • Open an issue in the TNG Community Forums
  • Send me directly an e-amil.

Revision History

Version Release Date Contents
V12.0.2.1e 16 nov 2019 No changes, but respects mod's naming conventions.
V12.0.2.1d 14 nov 2019 Added file selection via Windows Explorer - Added version number to generated files. Improved deletion of unused files. The temporary files are removed from the "mods" directory. The use of session variables made certain behaviors dangerous when generating "Easy Edit" files for multiple mods.
V12.0.2.1c 06 nov 2019 Takes in account the originals quotes of the variables (important for some mods).
V12.0.2.1a 03 nov 2019 Fix an error in showing EEGen's error messages.
V12.0.2.1 01 nov 2019 Première version.

Sites using this mod

If you download and install this mod, please add your TNG site to the table below: If you have a problem to do it, send me a mail...

URL User Note Mod-Version TNG-Version User-language
Racines luxo-hennuyeres Michel Kirsch Developpeur du Mod 12.0.2.6 12.0.2 FR/EN/NL/D/SP

Captures d'écran

Here are snapshots of the EEGen screens:

FR - Explications Image
Generator Main Page :

Once the program runned, this screen is showing. You can type or copy the name of the mod for which you want to generate the "Easy Edit" files. The name of the mod must be complete, with his extension. Example : balanced_media_v12.0.0.2.cfg. WITHOUT the name of the mods sub-folder.

        • NEW **** Use the button to use your files explorer !
Main Page
Help File :

In the left upper corner, you can call the help file of the generator. Basically in french language, it can be directly "Google translated".

Help file
Presentation of found parameters :

The list of the found parameters is showed. For each parameter, the list shows the name, the value; the program-deducted type, the default value, a short proposed description and the actual description. The user may change some of the values if necessary. The type if it is not correct, the default value and the short description. These short description will serve as label when editing the parameters.

Propose Vars
Modification of parameter type :

The parameter type may take 3 different values : text, boolean ou color (see the help file for explanations).

3 types
"Easy Edit" files generation :

Once the necessary modifications done, click on "Save". A new button "Generate" appears. If you want to make an another change to the parameters, don't forget to save them once again before generate the "Easy Edit" files. The original mod file is saved : TNGroot/xxx.cfg.origin and two files are generated : the admin file : TNGroot/eegen_xxx_admin.php and an Help file : languages/English/eegen_xxx_help.php. ( where xxx represents the mod's name)
Those two files can easily but manually be modified to make them more user-friendly (admin file) or complete (help file).

Generate files
Easy Edit:

Once the files are generated, accessing the easy edition is done via the mod manager. In the concerned mod, two new buttons appears. [Easy Edit] and [Delete the Easy Edit files]. The generation process can be done more than one time. But don't forget to click the [Delete...] button before the next generation. The old files will be overwritten but the buttons will appears twice...
Clicking the [Easy Edit] button gives you access to the easy editing screen.

Boutons Easy Edit
Easy edition screen :

The screen shows all the parameters with the modifications you make. Look for the labels containing the short description. If they are not sufficient clear, you can destroy the files and make a new files generation.
The "boolean" type parameters shows a list of choice [Yes/No]. The "color" type are showed with a field of the actual color and an icon to change this color.
ATTENTION : The modifications you make will only be visible when you click on the [Save] button !
The screen shows [Close this window] et [Restore default values] buttons too.
ATTENTION : [Restore default values] restore ALL the parameters to their default values !

Easy Edit Screen
Help file :

The help file that has been generated is short and only includes the instructions present in the original Mod. It is up to the mod programmer to improve it in order to provide complete help to the user before making it available.
The help file can be directly translated via the "Google Translate" option in the header of the help file.

Easy Edit Screen
Here is a view of the generated files that have been improved before being made available....
Easy Edit Sosa