K4kArot2015 / sigplus

Automatically exported from code.google.com/p/sigplus
0 stars 0 forks source link

Easier help #62

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
According to me it is worth considering the simplification and standardization 
of service SigPlus and help system.
This will help you quickly deploy SIGPlus and should reduce the number of work 
on the creation of help.

Eg
.1. Standardize the configuration parameter names and syntax SIG plugin code in 
the article. According to me, it's better if BackEnd configuration will use 
proper parameter name. The parameter names are in my opinion very clear.

.2. Simplify the help files to a single parameter description with a note next 
to the name "BackEnd or FrontEnd '.
If the parameter is used in two ways, just do not you just add a description of 
the use by the "BackEnd or FrontEnd '. It is important that a full description 
of the parameter in one place.
You may want to create separate articles for each parameter and simply create 
the index by theme as it is now in the view SigPlus plugin configuration? This 
kind of small dictionary or encyclopedia SIGPlus.

.3. The current division of topics in the view window SigPlus plugin 
configuration is easy to read and allows you to associate the parameter in its 
proper context.

.4. If the parameter is in a separate artylkule is, according to me, it would 
be great to make this description appear as a description of tooltips on a 
yellow background SIGPlus plugin configuration. If the description is long to 
cool the tooltips appear link "read more" to help article on SIGPlus. (audience 
will be ... ;))

Thank you for the whole of this contribution and congratulate a good idea, I am 
convinced that GIS Plus is destined for success and should soon change its name 
to "Simple Gallery F-1" (Force) or something like that better expresses the 
capabilities of the tool.
If I can not be 100% wrong in what I propose to apologize in advance.

Regards!

Original issue reported on code.google.com by ten.mari...@gmail.com on 5 Dec 2012 at 9:40

GoogleCodeExporter commented 9 years ago
Continuing the idea, in the current tooltips miss the content of such a system:
"
preview_margin
Occurs: FrontEnd / BackEnd
Purpose: Margin (with or without unit).
Syntax eg: preview-margin = 4
Effects: Adds a margin of 4 pixels around the border of each image in the 
gallery.

Summary: Margin around preview images [px], use a number with or without a 
unit, numbers without a default unit is pixels (px). The margin clears a 
completely transparent area around the border. If omitted, the margin Specified 
in the style sheet file (sigplus.css) Applies.

Expected value: empty (that inherit from stylesheet), a nonnegative integer 
(pixels), or a CSS dimension value with a unit.
"
One simple info in one place, and a link to more if needed.

Original comment by ten.mari...@gmail.com on 6 Dec 2012 at 1:47

GoogleCodeExporter commented 9 years ago
and According to me, it is very important also for the rapid deployment and 
promotion sigplus that there are examples of the use of a specific parameter in 
the example images in the gallery.

Ideally, such examples were immediately help page with a description of the 
parameter. Ready examples album are the best way to discover the possibilities 
SigPlus the beginner, for which SigPlus may seem too complicated to create fast 
and simple gallery.

In addition, an interesting idea is a gallery of GIS Plus, with all 
parametreami that can instantly change and test.
Example: http://www.w3schools.com/tags/tryit.asp?filename=tryhtml_image_test

Original comment by ten.mari...@gmail.com on 6 Dec 2012 at 1:48