Difference between revisions of "Easy Edit Generator"

From TNG_Wiki
Jump to navigation Jump to search
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{restricted}}
 
{{Languages|EEGen}}
 
{{Languages|EEGen}}
 
{{TNGmod
 
{{TNGmod
Line 4: Line 5:
 
| mod_summary    = Generates an Easy Edit file for mods using many parameters.
 
| mod_summary    = Generates an Easy Edit file for mods using many parameters.
 
| mod_validation  =  
 
| mod_validation  =  
| mod_last_update = 03 nov 2019
+
| mod_last_update = 16 nov 2019
| download_link  = for {{Tv120}}<br/> [http://compteur.mkirsch.be/compte.php?id=6&user={{#replace:{{CURRENTLOGGEDUSER}}}}&page={{PAGENAMEE}} EEGen v 12.0.2.1a]
+
| download_link  = for {{Tv120}}<br/> [http://compteur.mkirsch.be/compte.php?id=15&user={{#replace:{{CURRENTLOGGEDUSER}}}}&page={{PAGENAMEE}} Easy_Edit_v 12.0.2.1e]
 
| download_stats  = [http://compteur.mkirsch.be/collect.php?action=collect Montrer les statistiques]
 
| download_stats  = [http://compteur.mkirsch.be/collect.php?action=collect Montrer les statistiques]
 
| mod_author      = [[User:MichelKirsch|Michel Kirsch]]
 
| mod_author      = [[User:MichelKirsch|Michel Kirsch]]
Line 11: Line 12:
 
| mod_support    = [http://tng.community/ TNG Community Forums]
 
| mod_support    = [http://tng.community/ TNG Community Forums]
 
| mod_contact    = [[Image:Image mail.png|MyMail]]
 
| mod_contact    = [[Image:Image mail.png|MyMail]]
| mod_version    = 12.0.2.1a for TNG v12
+
| mod_version    = 12.0.2.1e for TNG v12
 
| min_TNG_ver    = n.c
 
| min_TNG_ver    = n.c
 
| max_TNG_ver    = 12+
 
| max_TNG_ver    = 12+
Line 23: Line 24:
 
|}
 
|}
 
<br>
 
<br>
== But du Mod ==
+
== 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.<br>
 
This mod installs a generator program which generate files which permits an easy edit of the parameters of a given mod.<br>
 
The easy edit parameters file generated can be attached to the mod to givez the user of the mod an "user friendly" parameters screen.<br />
 
The easy edit parameters file generated can be attached to the mod to givez the user of the mod an "user friendly" parameters screen.<br />
Line 35: Line 36:
 
== Requirements ==
 
== Requirements ==
 
'''A TNG 12.0.2+''' installation in working order.<br>
 
'''A TNG 12.0.2+''' installation in working order.<br>
This program was tested with the mods [[https://tng.lythgoes.net/wiki/index.php?title=OpenStreetMap '''Open Street Map''']], [[https://tng.lythgoes.net/wiki/index.php?title=Living_Color_Mod '''Living Color''']], [[https://tng.lythgoes.net/wiki/index.php?title=Balanced_Media '''Balanced Media''']], [[https://tng.lythgoes.net/wiki/index.php?title=Living_Color_Mod '''Living Color''']], [[https://tng.lythgoes.net/wiki/index.php?title=Census_Plus_International '''Census Plus International''']] ==> see '''(*)''', [[https://tng.lythgoes.net/wiki/index.php?title=OpenStreetMap '''Open Street Map''']] and [[https://tng.lythgoes.net/wiki/index.php?title=Sosa '''Sosa''']]. <br />  
+
This program was tested with the mods [[OpenStreetMap]], [[Living Color Mod]], [[Balanced Media]], [[https://tng.lythgoes.net/wiki/index.php?title=Living_Color_Mod '''Living Color''']], [[https://tng.lythgoes.net/wiki/index.php?title=OpenStreetMap '''Open Street Map''']] and [[https://tng.lythgoes.net/wiki/index.php?title=Sosa '''Sosa''']]. <br />  
 
'''ATTENTION: ''' It will not works with mods having parameters in '''more than one file''', as example the mods [[https://tng.lythgoes.net/wiki/index.php?title=Show_All_Family '''Show All Family''']] or [[https://tng.lythgoes.net/wiki/index.php?title=Add_Person_Siblings_Row '''Add Person Siblings Row''']].
 
'''ATTENTION: ''' It will not works with mods having parameters in '''more than one file''', as example the mods [[https://tng.lythgoes.net/wiki/index.php?title=Show_All_Family '''Show All Family''']] or [[https://tng.lythgoes.net/wiki/index.php?title=Add_Person_Siblings_Row '''Add Person Siblings Row''']].
  
 
This program works certainly with many others mods. Thanks to keep me informed or update this list of mods.<br>
 
This program works certainly with many others mods. Thanks to keep me informed or update this list of mods.<br>
 
'''(*)''' NOTE : Developper of the mod ([[User:KenRoy|'''Ken Roy''']]) will NOT accept problems if the changes made by "Easy Edit" do not work correctly.
 
  
 
== Before installation ==
 
== Before installation ==
Line 54: Line 53:
  
 
== UNinstalling ==
 
== 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  !!
+
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 ==
 
== Update ==
Line 67: Line 68:
 
* '''Send''' me directly an e-amil.
 
* '''Send''' me directly an e-amil.
  
== Historic of modifications ==
+
== Revision History ==
  
 
{| border="1" cellspacing="5" cellpadding="2" width="100%" class="wikitable"
 
{| border="1" cellspacing="5" cellpadding="2" width="100%" class="wikitable"
Line 74: Line 75:
 
! Release&nbsp;Date
 
! Release&nbsp;Date
 
! Contents
 
! 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  
 
| V12.0.2.1a  
Line 84: Line 97:
 
|}
 
|}
  
== Sites utilisant ce Mod ==
+
== Sites using this mod ==
Si vous chargez et installez ce Mod, veuillez ajouter votre site TNG à la table ci-dessous :
+
If you download and install this mod, please add your TNG site to the table below:
Si vous n'y parvenez pas, envoyez-moi un mail !
+
If you have a problem to do it, send me a mail...
  
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
Line 103: Line 116:
 
| 12.0.2
 
| 12.0.2
 
| FR/EN/NL/D/SP
 
| FR/EN/NL/D/SP
 +
|-
 +
| [http://www.myfamily-reunion.org/ancestry/ Furna, Brava, Cabo Verde]
 +
| [[User:FifthEditon|FifthEditon]]
 +
|
 +
| v12.0.2.1e
 +
|
 +
| EN
 
|}
 
|}
 +
 
== Captures d'écran ==
 
== Captures d'écran ==
'''Voici quelques snapshots des écrans du générateur et des fichiers générés: '''<br>
+
'''Here are snapshots of the EEGen screens: '''<br>
  
 
{| border="1" cellspacing="0" cellpadding="5" width="100%" class="wikitable"
 
{| border="1" cellspacing="0" cellpadding="5" width="100%" class="wikitable"
Line 114: Line 135:
  
 
|-
 
|-
|Page principale du générateur :<br>
+
|Generator Main Page :<br>
Une fois le programme démarré, l'écran suivant se présente qui vous permet de saisir le nom du fichier cfg du mod pour lequel vous voulez générer un fichier "Easy Edit". Le nom du mod doit être complet, avec son extesnsion. Exemple : balanced_media_v12.0.0.2.cfg. Il NE faut PAS y mettre le nomd du répertoire Mods. <br>
+
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. <br>
 +
**** NEW **** Use the button to use your files explorer !
  
 
|[[Image:Main Page.jpg|thumb|left|Main Page]]
 
|[[Image:Main Page.jpg|thumb|left|Main Page]]
  
 
|-
 
|-
|Fichier d'aide :<br />
+
|Help File :<br />
Dans le coin supérieur gauche, vous pouvez activer le fichier d'aide du générateur. Le fichier peut être traduit par l'utilisateur grâce à l'option "Google Translate" prévue dans le coin supérieur droit.
+
In the left upper corner, you can call the help file of the generator. Basically in french language, it can be directly "Google translated".
  
 
|[[Image:Help.jpg|thumb|left|Help file]]
 
|[[Image:Help.jpg|thumb|left|Help file]]
  
 
|-
 
|-
|Présentation des paramètres :<br>
+
|Presentation of found parameters :<br>
La liste des paramètres retrouvés pour le mod est présentée. Pour chaque paramètre, la liste reprend le nom, la valeur, le type (déduit par le programme), la valeur par défaut, une description courte proposée et la description. L'utilisateur peut alors modifier certaines de ces valeurs en fonction de ses besoins. Le type s'il n'est pas correct, la valeur par défaut et la description courte, si elle n'est pas suffisamment explicite. Cette courte description servira comme étiquette pour le  paramètre lors de l'édition.
+
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.
  
 
|[[Image:Propose.jpg|thumb|left|Propose Vars]]
 
|[[Image:Propose.jpg|thumb|left|Propose Vars]]
  
 
|-
 
|-
|Modification du type du paramètre : <br>
+
|Modification of parameter type : <br>
Le type de paramètre peut prendre 3 valeurs différentes : text, boolean ou color (voyez le fichier d'aide).
+
The parameter type may take 3 different values : text, boolean ou color (see the help file for explanations).
 
|[[Image:Types.jpg|thumb|left|3 types]]
 
|[[Image:Types.jpg|thumb|left|3 types]]
  
 
|-
 
|-
|Génération des fichiers "Easy Edit" :<br />
+
|"Easy Edit" files generation :<br />
Une fois les modifications nécessaires apportées, cliquez sur Sauvegarder. Un nouveau bouton "Générer" apparaît. Si vous désirez apporter un nouveau changement aux paramètres, faites-le maintenant et n'oubliez pas de '''sauver à nouveau''' avant de générer les fichiers "Easy Edit". <br />
+
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.
Le Mod original est sauvegardé  : racine modspath/'''xxx'''.cfg.origin et deux fichiers sont générés : le fichier principal : racine TNG/eegen_'''xxx'''_admin.php et un fichier d'aide : languages/English/eegen_'''xxx'''_help.php. ( '''xxx''' représente le nom du mod)<br />
+
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)<br />
Ces deux fichiers peuvent aisément être modifiés afin de rendre la vue encore plus attrayante et plus fonctionnelle (fichier admin), ou plus complète (fichier d'aide).
+
Those two files can easily but manually be modified to make them more user-friendly (admin file) or complete (help file).
  
 
|[[Image:Generate.jpg|thumb|left|Generate files]]
 
|[[Image:Generate.jpg|thumb|left|Generate files]]
  
 
|-
 
|-
|Edition facile: <br />
+
|Easy Edit: <br />
Une fois les fichiers générés, l'accès à l'édition facile se fait via le Mod Manager. Dans le Mod concerné, deux nouveaux boutons sont apparus: [Edition facile] et [Effacer les fichiers Easy Edit]. Le processus de génération peut être renouvelé autant de fois que vous le voulez. Cependant, n'oubliez pas d'effacer les fichiers déjà générés avant de générer les nouveaux à l'aide du bouton [Effacer les fichiers Easy Edit]. Si vous ne le faites pas, rien de grave : les anciens fichiers seront écrasés, mais les boutons du mod seront doublés...
+
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...<br />
En cliquant sur le bouton [Edition facile] vous accédez au fichier de paramétrage facile.  
+
Clicking the [Easy Edit] button gives you access to the easy editing screen.  
 
|[[Image:EasyEditButton.jpg|thumb|left|Boutons Easy Edit]]
 
|[[Image:EasyEditButton.jpg|thumb|left|Boutons Easy Edit]]
  
 
|-
 
|-
|Ecran de paramètrage facile : <br />
+
|Easy edition screen : <br />
Le fichier de paramétrage facile reprend tous les paramètres rencontrés avec les modifications que vous y avez éventuellement apportées. Remarquez notamment les étiquettes contenant la description courte que vous avez pu modifier avant la génération des fichiers. Si les étiquettes ne sont pas assez parlante, détruisez les fichiers et recommencez le processus. <br />
+
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. <br />
Les paramètres de type "boolean" ont une liste de choix [oui/non]. Les types "color" sont accompagnés d'un champ indiquant la couleur actuelle et d'une icône permettant de choisir une autre couleur.<br />
+
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.<br />
ATTENTION : les modifications que vous apportez ne sont prises en compte et visibles que lorsque vous aurez cliqué sur [Sauvegarder] !<br />
+
ATTENTION : The modifications you make will only be visible when you click on the [Save] button !<br />
En plus de ce bouton, les boutons [Fermer la fenêtre] et Restaurer les valeurs par défaut] sont apparents.<br />
+
The screen shows [Close this window] et [Restore default values] buttons too.<br />
ATTENTION : [Restaurer les valeurs par défaut] restaure TOUTES les paramètres à leur valeur par défaut !
+
ATTENTION : [Restore default values] restore ALL the parameters to their default values !
 
|[[Image:EasyEditScreen.jpg|thumb|left|Easy Edit Screen]]
 
|[[Image:EasyEditScreen.jpg|thumb|left|Easy Edit Screen]]
  
 
|-
 
|-
|Fichier d'aide : <br />
+
|Help file : <br />
Le fichier d'aide qui a été généré est succint et ne reprend que les instructions présentes dans le fichier '''xxx'''.cfg d'origine du Mod. Il appartient au programmeur du mod de l'améliorer afin de fournir une aide complète à l'utilisateur avant de le mettre à disposition.<br />
+
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. <br />
Le fichier d'aide est directemment traduisible via l'option "Google Translate" présent en en-tête du fichier d'aide.
+
The help file can be directly translated via the "Google Translate" option in the header of the help file.
 
|[[Image:EasyEditHelp.jpg|thumb|left|Easy Edit Screen]]
 
|[[Image:EasyEditHelp.jpg|thumb|left|Easy Edit Screen]]
  
 
|-
 
|-
|Voici une vue des fichiers générés qui ont été améliorés avant mis à disposition...
+
|Here is a view of the generated files that have been improved before being made available....
 
|[[Image:EasyEditSosa.jpg|thumb|left|Easy Edit Sosa]]
 
|[[Image:EasyEditSosa.jpg|thumb|left|Easy Edit Sosa]]
  
  
 
|}
 
|}
 +
 +
 +
[[Category:Mods for TNG v12]]
 +
[[Category:Other Scripts]]

Revision as of 04:20, 5 June 2020

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
Caution If you have trouble downloading with Google Chrome, Vivaldi, Brave or other Chromium based browser, try using a right-click and select Open in new Window, then F5, or use another browser such as Firefox


Caution


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
Furna, Brava, Cabo Verde FifthEditon v12.0.2.1e EN

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