English > Support

Manuals

(1/2) > >>

buah:
The topic about manuals is locked, so I had to ask (to suggest) following in a separate one.

I don't know anything about xml, but I'm trying to make a skin, so I use PVD Skin Engine Manual a lot. It's a resource of a great help, indeed. Especially for us newbies.

What I found it might be helpful was to indicate default values, so it would be easier to decide whether or not to implement particular functions. Xml file also would be of a smaller size, without unnecessary (duplicated) data.

I apologize if I didn't understand that there weren't default values, and that it wasn't the way how things work.

rick.ca:
In the extremely rare case a programmer produces documentation, I'm not sure it's appropriate to comment. But since you've opened the door, some suggestions for the Export Templates Manual...

It would be helpful if the parameters in the Field Values tables were linked to the Field Parameters table. It's right below (duh!), but I forget and find myself staring blankly at a parameter like "custom"—thinking I'm supposed to know what that means (and never remembering "set to true if you want to retrieve a custom field value"). :-[

There should be a link to manual on the Templates for Plain Text Export window in the program. Not only would that be useful, it would reinforce the idea the templates provided are just examples and are meant to be modified.inhelp

buah:
I believe that in PVD Skin Engine Manual Front Cover field is accidentally defined as <frontcover> instead <froncover>?

nostra:

--- Quote ---What I found it might be helpful was to indicate default values, so it would be easier to decide whether or not to implement particular functions.
--- End quote ---

I'll check the manual for places where default values can/should be documented.


--- Quote ---It would be helpful if the parameters in the Field Values tables were linked to the Field Parameters table. It's right below (duh!), but I forget and find myself staring blankly at a parameter like "custom"—thinking I'm supposed to know what that means (and never remembering "set to true if you want to retrieve a custom field value"). Embarrassed
--- End quote ---

So where exactly you want this link to be placed?


--- Quote ---There should be a link to manual on the Templates for Plain Text Export window in the program. Not only would that be useful, it would reinforce the idea the templates provided are just examples and are meant to be modified.
--- End quote ---

OK, why not


--- Quote ---I believe that in PVD Skin Engine Manual Front Cover field is accidentally defined as <frontcover> instead <froncover>?
--- End quote ---

Thx, I'll fix this

rick.ca:

--- Quote ---So were exactly you want this link to be placed?
--- End quote ---

I think linking the column headings ("Parameters") would provide a sufficient indication the values in the column are explained elsewhere.
inhelp

Navigation

[0] Message Index

[#] Next page