Template:SimplSVG/doc

This documentation is incomplete and unclear.

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:SimplSVG.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာ မန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha ∙ Tiếng Việt ∙ 简体中文 ∙ 繁體中文 ∙ +/−

This template is used for marking SVG files which use "simplified" code. Such files must have their source code suitable for manual editing. SVG files are simplified by (generally radical) optimization of files created by SVG editors.^[3]

The template automatically sets the following categories:

SVG Simplified or (depending on parameter #1 and #4 to #7) one of its subcategories or
Valid SVG created with Text Editor or (depending on parameter #1) one of its subcategories or
Structured SVG controlled by parameter #5 to #7 = "H"^{[clarification needed]} or
none if suppressed (parameter #4 = "X" or "Y")
SVG files to be drawn by hand if only tagging files or categories (see: parameter #3)^{[clarification needed]}

By template {{ValidSVG}} the file is categorized also into Valid SVG created with Text Editor, a hidden subcategory of hidden Valid SVG^{[clarification needed]}

✓The source code of this SVG is valid.

This link to the validator passes the option to show the SVG coding.

Usage

or {{ Image generation | sb = size_before | sa = size_actual | other parameters as described below }} 0(both parameters: sb and sa)
or {{ Image generation | 10 = S | other parameters as described below }} (see the documentation) to use the advantages of the template {{Image generation}},

e.g. creation of the Other fields / Information field, for a better and more uniform appearance in the {{Information}} box

or File generation description with parameter "Simplified SVG"^{[clarification needed]}

Deutsch: Mit dem 4. Parameter kann die Kategorisierung gesteuert werden, siehe {{HandSVG}}.

English: Categorization can be controlled by parameter #4, see {{HandSVG}}.
Because just examples are useful and not crowding the categories with each file from a set of similar ones, any such categorization can be suppressed explicitly.^{[clarification needed]}

Another possibility is diffusion to a subcategory by providing parameter #4 with a control character (see explanation at docu of {{HandSVG}}).

The file is categorized as SVG Simplified when:

forced by categorization parameters,
or
categorization is not suppressed and both file sizes are specified and the size afterwards is less than a twentieth of the size before.

In all other cases it is categorized as Valid SVG created with Text Editor. To prevent this category from becoming too crowded the (vector software)-assigned subcategory is selected instead, when the software name is specified by parameter #1.

For layout examples see the talk page.

Template parameters

Parameter Description Default Status

1 created with The name of the graphics tool: Inkscape, Sodipodi, Adobe Illustrator, OpenOffice, CorelDRAW, …^{[clarification needed]} empty optional

2

sb

size before

The size the file had when saved by the graphics tool.
To see file sizes in bytes on description pages, you can use simpleSVGcheck.js.

empty

optional

3

sa

size actual

The size of the manually edited version
not specified if = 000; see Category:SVG files to be drawn by hand^{[clarification needed]}

empty

optional

4

control

Either uppercase S, M, N, X, or Y

S: categorization forced to SVG Simplified
M: categorization forced to category of editor as parameter #1
N: without explanatory text^{[clarification needed]}
X: any categorization is suppressed
Y: combines N and X

or a Control letter (see {{HandSVG}}): diffusion into subcategories of SVG Simplified^{[clarification needed]}

empty

optional

5 structured? character "H":^[1] it is a high quality structured graphic^{[clarification needed]} empty optional

6 talk page? character T:^[1] an additional explanation points to the file talk page^{[clarification needed]} empty optional

7

categories (coded)

a one-character code^[1] for more categories:

SVG simplification by …

a → avoidance
b → viewBox
c → cloning
d → dasharray
e → elimination
f → fill pattern
g → grouping
k → clipping
l → linecapping
p → gradienting
% → text embedding
t → transforming

empty

optional

user edited by name of editor (person) who simplified the image, either the user name or in wiki code
coded e. g. with {{U}}, {{Uc}}, {{Ut}}, {{Ult}}, {{Ud}} or otherwise empty optional

sub

subcat
subcategory

diffusion in "SVG Simplified"

category diffusion: a suffix to the category name depending on parameter #2, e. g. sub=-examples^{[clarification needed]}

empty

optional

sss diffusion in "structured SVG" more category diffusion: Structured SVG Subcategory, e. g. sss=-examples^{[clarification needed]} empty optional

vsub diffusion in "valid/invalid" diffusion for Valid SVG created with Text Editor / Invalid SVG created with Text Editor
To suppress this subcategorizing set it to minus: vsub=-^{[clarification needed]} empty optional

key sort key sort key within the category empty optional

width sets width for the box^{[clarification needed]} auto optional

style sets or overrides other style attributes for the box.^{[clarification needed]} Setting a value (like "<nowiki/>") prevents the newline which this template adds after itself by default. empty optional

topic to specify the short code (e.g. "f" for "flag, "i" for "icon") of a topic empty optional

vwidth sets width for the box of {{Valid SVG}} / {{Invalid SVG}} width optional

vstyle

vs

This description is very incorrect. vstyle and vs are not really aliases and may behave differently with the special value "none". They also interact with the style parameter.

to set or overwrite other style attributes for the box of {{Valid SVG}} / {{Invalid SVG}}
e.g. vstyle=float:left, or short vs=fl for also smaller icon

for smallest display use vs=n or vs=- (see examples)

style

optional

vtext optional additional text for ValidSVG/InvalidSVG . optional

pu previous user name^{[clarification needed]} empty optional

Template data

Parameter text is empty

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

This template is used for marking SVG files which use "optimal" code. Such files must have their source code suitable for manual editing. Optimal SVGs are created either manually (see "Created with Text Editor" template) or by (generally radical) optimization/simplification of files created by SVG editors.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
created with	`1`	The name of the [[:Category:Anti vector graphics program logos\|graphics tool]]: Inkscape, Sodipodi, Adobe Illustrator, OpenOffice, CorelDRAW, …<sup>[''[[:en:Wikipedia:Please_clarify\|clarification needed]]'']</sup>	String	optional
size before	`2` `sb`	The size the file had when saved by the graphics tool.<br> To see file sizes in bytes on description pages, you can use [[Commons:Scattered scripts#simpleSVGcheck.js\|simpleSVGcheck.js]].	Number	optional
size actual	`3` `sa`	The size of the manually edited version; not specified if="000"; see Category:SVG files to be drawn by hand	Number	optional
control	`4`	Either uppercase S, M, N, X or Y; "X" and "Y": any categorization is suppressed; "M": categorization forced to category of editor as parameter #1; "S": categorization forced to Category:SVG Simplified; "N" or "Y": without explanatory text; or a Control letter (see Template:HandSVG): diffusion into subcategories of Category:SVG Simplified	String	optional
structured?	`5`	character <code>H</code>: it is a "high quality structured graphic"	String	optional
talk page?	`6`	character "T": an additional explanation points to the file talk page	String	optional
categories (coded)	`7`	a one-character code for more categories: SVG simplification by … a → avoidance b → viewBox c → cloning d → dasharray e → elimination f → fill pattern g → grouping k → clipping l → linecapping p → gradienting % → text embedding t → transforming	String	optional
sort key	`key`	sort key within the category	String	optional
	`pu`	previous user name<sup>[''[[:en:Wikipedia:Please_clarify\|clarification needed]]'']</sup>	Unknown	optional
diffusion in "structured SVG"	`sss`	more category diffusion: Structured SVG Subcategory, e. g. sss=-examples	String	optional
	`style`	sets or overrides other style attributes for the box.<sup>[''[[:en:Wikipedia:Please_clarify\|clarification needed]]'']</sup> Setting a value (like "<nowiki/>") prevents the newline which this template adds after itself by default.	String	optional
diffusion in "SVG Simplified"	`sub` `subcat` `subcategory`	category diffusion: a suffix to the category name depending on parameter #2, e. g. sub=-examples	String	optional
	`topic`	to specify the short code (e.g. "f" for "flag, "i" for "icon") of a [[:Template:Igen/top\|topic]]	Unknown	optional
edited by	`user`	name of editor (person) who simplified the image, either user name or in wiki code	User	optional
	`vstyle` `vs`	to set or overwrite other style attributes for the box of Valid SVG / Invalid SVG<br> e.g. vstyle=float:left, or short vs=fl for also smaller icon<br> ---- for ''smallest display'' use vs=n or vs=- Default <code>style</code>	Unknown	optional
diffusion in "valid/invalid"	`vsub`	diffusion for "Valid SVG created with Text Editor" / "Invalid SVG created with Text Editor"; To suppress this subcategorizing set it to minus: "vsub=-"	String	optional
	`vtext`	optional additional text for ValidSVG/InvalidSVG Default <code>.</code>	Unknown	optional
	`vwidth`	sets width for the box of Valid SVG / Invalid SVG Default <code>width</code>	Unknown	optional
	`width`	sets width for the box<sup>[''[[:en:Wikipedia:Please_clarify\|clarification needed]]'']</sup> Default <code>auto</code>	Number	optional

Additional information

The template is intended to be used in the following namespaces: the File namespace

The template is intended to be used by the following user groups: all users

Template:SimplSVG/doc

Contents

Usage

Template parameters

Additional information

See also

Navigation menu

Template:SimplSVG/doc

Usage

Template parameters

Additional information

See also

Navigation menu

Search