Template talk:File generation description

History: The making of the template

Contribution of many users (see also first version):

Not a very user friendly template

(copied from Template talk:Image generation

It takes me quite a bit of screen-staring to figure out where to start with the documentation, and for most other templates it is possible to see what the template does just by looking at the source code which calls it in mainspace/filespace pages. I suggest splitting the template up into simpler parts, or at least avoiding the use of single-character symbols. I'll get there, but other users may be too confused and just give up. --BurritoBazooka (talk) 22:17, 10 November 2016 (UTC)

You are completely right, it is not userfriendly at all. To have everything about file development in one template makes it much too complicated. Users should install the script, which makes the use simple even to novices. If experts want to use more options they can study - and test - how to do that. Sorry sarang♥사랑 12:59, 30 November 2016 (UTC)

More discussions, from user talk pages

Chem. Formeln
Hallo Kopiersperre, du hast neulich wieder eine Reihe guter Grafiken hochgeladen. Leider hast du sie in eine Metakategorie gestellt, deswegen musste ich sie alle wie diese nachbearbeiten. Ea wäre IMHO natürlich besser wenn gleich die "richtige" Kategorie gewählt würde. Freundlicher Gruss sarang♥사랑 09:14, 6 December 2016 (UTC)

{{Igen|c|+|<}} ist extrem kryptisch und damit maximal benutzerfeindlich … --Leyo 12:59, 6 December 2016 (UTC)

Hallo Leyo, es geht auch total unkryptisch; genau dasselbe lässt sich so codieren:

{{Information field|Name=SVG{{I18n/COA|development}}|Value={{Created with ChemDraw|errors=0|vstyle=float:left}} {{TextSVG-s|s=sf}}}}

womit die Benutzerfreundlichkeit offensichtlich gewahrt ist. Verzeih mir bitte dass ich das umständlich finde!

Vom Script erfolgt der Vorschlag folgenden Codes: {{Igen|ChemDraw|+|s=|T={{Text-SVG}}}} was zwar nur marginal besser ist, aber -sehr benutzerfreundlich!- den Anwender weitgehend entlastet und die wesentlichsten Zuordnungen gewährleistet. mfg sarang♥사랑 18:16, 7 December 2016 (UTC)

Da gäbe es auch was dazwischen: Statt {{Igen|c|+|<}} wäre z.B. {{Image generation|ChemDraw|pathtext}} (oder ähnlich) VIEL weniger kryptisch und dennoch einigermassen kurz. Und für Ergänzungen per Script/Bot spielen ein paar Zeichen mehr ja eh keine Rolle. Versuche dich doch bitte mal in andere Benutzer reinzuversetzen. --Leyo 12:57, 27 June 2018 (UTC)

There is no reason against extending the switch list copied below in order to also enabling the use of full names.

|A|a=Illustrator
|B|b=BKchem
|C|c=ChemDraw
|D|d=CorelDRAW
|E|e=ElCompLib
|F|f=Fig2SVG
|G|g=Gnuplot
|H|h=Inkscape-hand
|I|Im|i|im|=Inkscape
|J|j=...
|L|l=LibreOffice
|M|m=MetaPost 
|O|o=Other tool
|P|p=Pstoedit
|Q|q=QGIS
|R|r=R
|S|s=Sodipodi
|T|t=HandSVG
|U|u=Unknown tool
|V|v=Vim
|W|w=Winplot
|X|x=Inkscape-extract

|A|a=Illustrator may become |A|a|Illustrator|illustrator=Illustrator etc. --Leyo 09:08, 6 July 2018 (UTC)

As the explanation in the docu said, and the template code realizes, you can either use one of the shortcuts above, or any other string - it will be preceeded with "Created with " to get a template name. So your above example will work with A, a, Adobe, Illustrator but not with "illustrator" because no uppercasing is done by the template. The user may use full names, with the restriction that they are case sensitive and they will prefixed to become a template name. The case sensitivity is sometimes a bit troublesome, with names like BKchem, ChemDraw but CorelDRAW, and others (neither ChemDRAW nor CorelDraw will work!). -- sarang♥사랑 14:53, 7 July 2018 (UTC)

Well, using {{lc:text}} or {{uc:text}} would solve this issue. --Leyo 21:11, 7 July 2018 (UTC)

---

@Leyo: Your desire depends just the present abbreviations - the other tool names can remain as-they-are,
they need to be specified case-sensitive (e.g. "perl" or "Dia" or "GIMP", other cases remain unknown).
In the same way that it is necessary to specify tool names without Igen correctly, it must be with Igen - just that the following list will tolerate every case (but no other errors):

.... {{#switch:{{lc:{{{1|}}}}}
|a|a$|ia|adobe|illustrator=Illustrator
|b|bkchem=BKchem
|c|chemdraw=ChemDraw
|d|coreldraw=CorelDRAW
|e|elcomplib=ElCompLib
|f|fig2svg=Fig2SVG
|g|gnuplot=Gnuplot
|h|inkscape-hand=Inkscape-hand
|i|im|inkscape|inkscape-important=Inkscape
|j=...<!--
   k -->
|l|libreoffice=LibreOffice
|m|metapost=MetaPost <!--
   n -->
|o|other tool=Other tool
|ooo|openoffice|openoffice.org=OpenOffice.org
|p|pstoedit=Pstoedit
|q|qgis=QGIS
|r=R
|s|sodipodi=Sodipodi
|t|text editor|handsvg=HandSVG
|u|unknown tool=Unknown tool
|v|vim=Vim
|w|winplot=Winplot
|x|inkscape-extract=Inkscape-extract
|-=-

Do you want any more changes?

To avoid misunderstandings

the template accepts full names, and the script proposes the full names; it is just possible to use also abbreviations. When an abbreviation is used, each novice user can see what the template has generated from it, without necessity to study the templates documentation. IMHO it is much more essential to get a well formatted description page displayed, than to care for a fluent readability of its source. -- sarang♥사랑 23:10, 1 August 2018 (UTC)

I support the change that you proposed based on my comments. Thanks.

There are situations, in which an image has to be replaced. If the Image generation template has very cryptic parameters, this may not be done correctly. It is also helpful not to have cryptic parts in the file description page source text, if other changes to that page are done by inexperienced users. --Leyo 23:00, 2 August 2018 (UTC)

Users which are too inexperienced will always have their difficulties to edit correctly; but of course they can be helped: either by giving good documentation with clarifying descriptions and explanations (if these users read them!), by making templates parameters self-explaining (ok, may be I missed that point), or by offering a tool that does all (or most) of the investigation how an image had been generated.

We have such a good tool, and it is easy to use. A minimum of experience is sufficient to work successful with the script.

Of course, it is always more difficult to describe image generation afterwards than it would have been for the creator itself; later it can be done just for best faith.

To help the less experienced users, I am thinking of another support. One way works well: the template expands very few parameter characters to a generation description which in most cases is translated in many languages (for some languages translation help is searched); the other way can be a tool which converts items offered in a check list to the parameters. I am not quite sure whether this will be helpful in reality; it will be another tool unknown to the inexperienced and novice users. Just in one case I see an advantage: something like a pop-up window which shows all possible topics, allowing to select with a simple tick the desired one. How about that? -- sarang♥사랑 08:50, 26 August 2018 (UTC)

Kryptik

(copied from Template talk:Image generation

Hallo Perhelion, wie wir wissen gibt es nicht nur Fans für unsere Aufräumbemühungen. Die deutliche Kritik der Gegner finde ich durchaus berechtigt - aber ich habe keine rechte Idee, wie ihnen entgegenzukommen wäre. Es liessen sich zwei Ansatzpunkte unterscheiden: die Eingabe zur ev. Ergänzung des Script-Edits, und die Leserlichkeit des erzeugten Codes; die angezeigte Ausgabe lässt IMHO nichts zu wünschen übrig? Dein Script erzeugt weitgehend leserlichen Code, während mein Extremismus von Vertretern der altehrwürdigen OMA angefeindet wird. Ich finde es besser die descriptions kurz zu halten - lange Texte machen sie nicht unbedingt leserlicher.
Die Einordnung in komplexe Kategoriestrukturen erfordert eine komplexe Beschreibung; die Kritik scheint sich nicht an die Komplexität der Strukturen zu richten sondern an meinen Versuch, komplexe Zuordnungen stark vereinfacht und abgekürzt darzustellen. Tatsache ist dass der Umgang mit Igen ohne eine gewisse Einarbeitung unverständlich bleibt. Ich habe unlängst eine ausführliche und komplette und sortierte Parameterreferenz erstellt, wo alles nachgelesen werden kann, aber nach meiner Erfahrung werden Dokumentationen eher nicht gelesen. Das scheint mit Sicherheit auch beim User & Admin Leyo der Fall zu sein.
Hast du vielleicht einen konstruktiven Vorschlag? sarang♥사랑 08:55, 8 December 2016 (UTC)

Hallo Sarang, auf Anhieb nicht, derart Bedenken habe ich allerdings auch schon kommen sehen. Ich werde morgen mal darüber nachsinnen, ich bin recht müde... (von der Woche) LG ↔ User: Perhelion 00:29, 9 December 2016 (UTC)

Der oben bereits erwähnte User & Admin Leyo scheint jeder Änderung solcher Art feindlich gegenüberzustehen. Sogar die automatische script-Anpassung der Parameternamen missfällt ihm. Jetzt muss ich noch darauf achten dass ich keine Dateien von ihm kategorisere!

Hätte ich statt |other fields={{Igen|u|+|s=sf}} die Langform |Other fields={{Information field|Name=SVG{{I18n/COA|development}}|Value={{Created with Other tool|errors=0|vstyle=float:left|subcat=:Structural formulas}}}} oder etwas abgekürzt |Other fields={{InFi|SVG{{I18n/COA|development}}|{{Other tool|v|vs=fl|sub=:Structural formulas}}}} geschrieben - er hätte sicher auch angemeckert, dass es zu unleserlich und zu kryptisch ist... Dabei fehlt hier noch das Kategorisierungs-tag für path_text ("<" bezw. "{{TextSVG-s|s=sf}}").

Ich denke es ist völlig unmöglich es allen recht zu machen. Es bleibt lediglich zu versuchen es möglichst gut zu machen, und dabei die Bedürfnisse der Mehrheit von Normal-usern im Blick zu behalten. Image generation ist entwickelt worden um die Kategoriedifferenzierung zu vereinfachen - dabei sind Kategorien den meisten recht egal! Nun gut, ich mache halt weiter, und achte darauf keine Leyo-Dateien anzufassen, bleiben diese eben unkategorisiert. sarang♥사랑 11:51, 12 December 2016 (UTC)

@Sarang: Hm ja, dann füge doch bei ihm die ausführliche Form ein. :P Meinst du ich sollte dafür einen extra Button schaffen? PS: Das mit Category:Uploaded with UploadWizard hat sich nun auch erl. Auf jeden Fall wollte ich das Script dahingehend erweitern Syntax-Formatierungen auch ohne API-Anfrage (ans W3, wenn schon ausgeführt, oder mittels 2. Button) zu erl.!? LG ↔ User: Perhelion 13:45, 12 December 2016 (UTC)

Nein, ich finde wir müssen nicht Sonderbehandlungen für mäkelige Admins einführen! Und komplexere Kategorien benötigen eben komplexere Links, da ist die Langform nun mal nicht auf einen Blick lesbar. Und die Kurzform zu kryptisch. Ich lasse den Leyo und seine Dateien künftig in Ruhe, das ist für mich erledigt.

Wenn du aber meinst es bringt einen heuristisch relevanten Gewinn die Igen-Parameter in der Langform zu verwenden, also statt kurzem den sprecherenden Alias zu bevorzugen (wie dein script es ohnehin meist vorschlägt) und defaults auszuschreiben statt wegzulassen, bleibt noch die Frage ob es jemand zu würdigen weiss wenn du dir diese Zusatzarbeit antust. Ich bin da etwas skeptisch. mfg sarang♥사랑 14:08, 12 December 2016 (UTC)

Proposal for "Image generation"

(copied from User talk:Perhelion/simpleSVGcheck.js

(mal schnell auf deutsch:) Mir deucht es gäbe eine Art Lösung die alle zufriedenstellen könnte. Wenn ein Konsens besteht, dass ich diese Idee weiterverfolgen sollte, würde ich das ganz eng mit Leyo abstimmen, der dazu am meisten zu sagen hat. Ich denke an eine Art Meta-Vorlage, mit einem sehr sprechenden Namen (meinetwegen auch noch redirects, wenn das hilft), und sehr ausführlichen und ebenfalls sprechenden Parameternamen (nur Namensparameter! Meinetwegen auch noch aliases, wenn das hilft). In der ersten Version können mal die wichtigsten Dateieigenschaften beschrieben werden. Diese Vorlage prüft die Eingaben, weist Unkorrektes mit ausführlichen Fehlerhinweisen ab, und wenn alles stimmt kryptisiert sie die Angaben und ruft damit Image generation auf, das also unsichtbar im Hintergrund abläuft und die eigentliche Arbeit macht.
Statt zB {{ Igen | I | 3 | + | % | gd | s = sf }} könnte dann etwa geschrieben werden (ich bleib mal bei deutsch)
{{ Dateieigenschaften | SVG-Werkzeug = Inkscape | W3C-Fehleranzahl = 3 | Text = eingebettet | GraphicLab = de | Dateityp = Strukurformel }}
Natürlich liesse sich das ganz so gestalten, wie es gewünscht wird - vorausgesetzt, es gibt einen Konsens. Bei true/false-Alternativen wie "Text=eingebettet" ist auch die Formulierung "Texteinbettung=ja" denkbar; "=nein" macht eben nichts, daselbe gilt für den Parameter "Text als Pfad=ja/nein". Nach und nach lassen sich alle relevanten Parameter so umsetzen. Damit eröffnet sich die Möglichkeit, Dateieigenschaften leserlicher zu beschreiben. Wenn englischsprachige Parameternamen ausreichen, wird es nicht allzu langatmig da en i.a. kompakter ist als de.
So eine Kodierung mit Namensparametern ist weit einfacher als Vorlage umzusetzen, als unbenannte Parameter an beliebiger Stelle wie Igen sie zulässt und auflöst; Erstellung, Bearbeitungen und Erweiterungen erfordern keine besonderen Kenntnisse; vor allem, wenn die Vorlage eine klare Struktur aufweist. Hingegen rate ich dringend davon ab, die Originalvorlage Image generation in diesem Sinn zu erweitern. Ob auch das script die leserliche Variante liefern kann, sei erst mal dahingestellt - eher ist ein Umsetz-Tool denkbar. -- sarang♥사랑 10:33, 28 June 2019 (UTC)

Die von dir skizzierte Lösung scheint mir vernünftig zu sein. Der Code wird nicht sooo viel länger, aber ist deutlich anwenderfreundlicher. Aus meiner Sicht reichen engl. Parameternamen und -werte. --Leyo 21:02, 8 July 2019 (UTC)

@Leyo: Wenn du konkrete Parameternamen und -werte vorschlagen willst, ich würde das 1:1 umsetzen. Vielleicht einstweilen nur zum obigen Beispiel, das kann ja dann unendlich erweitert werden. Wie oben gesagt, wenn es von Anfang an eine gute Struktur hat kann da jeder ran und sich ohne Probleme austoben. -- sarang♥사랑 14:00, 14 July 2019 (UTC)

Obiges Beispiel finde ich gut. Korrigiert werden sollte natürlich der Tippfehler in “GrapicLab”. Zudem versteht man unter “Dateityp” üblicherweise etwas anderes. Wie wär's mit “Thema” oder so? --Leyo 09:01, 15 July 2019 (UTC)

Da muss ich gestehen dass ich mir nicht viel Mühe gegeben habe für das obige allererste Beispiel. In Englisch kann es so aussehen:

{{ Image properties
0 | SVG tool = ChemDraw
0 | W3C error count = 3
0 | Text as path = yes
0 | Text embedded =  
0 | Graphic Lab = de
0 | Topic = structural formula }}

Als weitere Parameter kommen dazu User=, PGF data=, Bad SVG=, Fake SVG= und mehr.

Wenn das im Wesentlichen so bleiben soll, kann ich schon mal eine erste Version erstellen - zur weiteren Begutachtung. Ideen zu besseren Namen sind willkommen - darum geht es ja vor allem. -- sarang♥사랑 10:37, 15 July 2019 (UTC)

Ja, das passt. Vielleicht sollte man es dann auf Template talk:Image generation oder so vorstellen. --Leyo 19:48, 15 July 2019 (UTC)

Template name

(copied from User talk:Leyo)

Hi Leyo, still I am searching for a good (well desciptive and correct) name for the template. I think that either {{ Image developement }}, or {{ Image developement description }} will be well descriptive. Considering the fact that it will describe rather the technical parts of the development than the image itself, {{ File developement }} or {{ File developement description }} (short {{ File description }}) might be more correct. Both can be expressed with {{ Developement description }}, but just {{ Description }} or {{ Developement }} may be too short. Of course it can be as well in German:
Ein möglicher deutscher Name wäre somit {{ Bildentwicklung }} oder {{ Bildentwicklungsbeschreibung }}; analog ist es mit {{ Dateientwicklung }}, oder {{ Dateientwicklungsbeschreibung }}. Falls es einen deutschen Vorlagennamen geben soll, sind dazu deutsche Parameternamen angebracht. Um einen heillosen Denglish-Mix zuvorzukommen, ist eine redirect/aliases-Implementierung zu vermeiden, und stattdessen sicherzustellen, dass bei einem deutschen Vorlagennamen nur deutsche Parameternamen verwendbar sind. Zur Zeit entwickle ich ausschliesslich die englische Variante, kann aber ggf. eine eventuelle deutschsprachige Version im Auge behalten. -- sarang♥사랑 04:47, 28 July 2019 (UTC)

After having consulted Linguee I am not sure if “Image development” is the ideal name. I would prefer “Image generation”, but this wouldn't be possible I suppose. For practical reasons the template name should be in English IMHO. --Leyo 23:08, 2 August 2019 (UTC)

How about "Description of file generation" (most exact), "File generation description" (shorter), or "File generation" (less exact)? As I explained above it seems to me more correct because it describes how the file is made/generated and it does not tell anything about the shown image. And BTW, {{File generation}} assimilates to the other template name. -- sarang♥사랑 09:25, 3 August 2019 (UTC)

Well, {{File generation}} seems to be okay then. --Leyo 21:16, 11 August 2019 (UTC)

---

First off, in English "developement" is kind of an old-fashioned British spelling; "development" is much more common. For many people "image generation" would call to mind generating a raster image from an SVG. Maybe "SVG file-editing tool"? AnonMoos (talk) 03:41, 12 August 2019 (UTC)

---

Hi Leyo, at File generation description/doc you can see now the current state of the documentation. The name of the template itself must not be the same as on this version of the docu. As long as the template is under development and not fur use, all parameter names can be changed; with most of them I am content but for some I would be glad for better ideas.
May be that you will be the only one who uses this template, so you may design everything at your personal style! I can publish the template within the next days, it depends on you and that you are happy with it. -- sarang♥사랑 17:41, 14 August 2019 (UTC)

At first sight it looks good. BTW: I did not expect that the template would contain such a high number of parameters. --Leyo 21:29, 14 August 2019 (UTC)

As said before, normally two or three params would do it; but I tried to offer a larger part (not all!) of the possibilities of “Image generation”, to avoid that for every a bit more specialized case the unliked original has to be used. But of course, if somebody wants to use the new template, it is either possible always to restrict to the few most used parameters, or to study the documentation and have the advantage to express even more complicated cases. I tried to write the docu clear and easy, but I suppose that it will be read very seldom...

Ok, I shall now publish also the template itself. -- sarang♥사랑 05:00, 15 August 2019 (UTC)

First version

published today -- sarang♥사랑 06:40, 15 August 2019 (UTC) 0 Please tell me about all inconveniencies !

broken file param

@Sarang: Any idea why this is appearing on files such as File:2,6-Diiodophenol.svg even though the parameter isn't called. --Minorax^«¦talk¦» 09:08, 23 October 2022 (UTC)

Thank you for telling - I correced the error -- sarang♥사랑 09:21, 23 October 2022 (UTC)

SVG tool

@Sarang: If I specify the SVG tool (e.g. ChemDraw), the full stop at the end of "This structural formula was created with ChemDraw" is somehow floating. Can this be fixed? See for instance File:Chemical structural formula of (S)-Limonene.svg. Thanks in advance, — Chem Sim 2001 (talk) 17:57, 21 April 2023 (UTC)

@Chem Sim 2001: For test purposes, it is intended to show instead of the full stop a similar sign that it can seen from the outside that File generation description is used. It will be replaced again by the full stop - somewhen. Is it very disturbing for you, now you know? -- sarang♥사랑 08:49, 24 April 2023 (UTC)

@Sarang: Thanks for the information! It's not a big problem. — Chem Sim 2001 (talk) 15:15, 24 April 2023 (UTC)