List of WPS syntax and commands (including unsupported)

[HRM]

EDIT: I have finally found where the information is located. I will post the results as soon as I can.


I am sorry of this is the wrong forum, but it seems to be closest at least.

Looking through the wiki and even searching the web, I have not been able to find a complete list of all commands available. (Supported, as well as optional patches) If I look through the fancy custom themes, I can see the different variables, but it is not simple to reverse engineer everything. Since WPS themes  that need patches are available on rockbox-themes.org, I know that there are probably others in the same situation as I am.

Does anyone have a list or page with all available functions listed? Could someone update the wiki to include everything (including the fancy stuff) or post it somewhere? (Things like multiple fonts, or colored fonts) When I search "WPS syntax" I get pages with specific problems. Maybe I just need to know what to look for. Does it use code that is called something else, if so, what should I search for?

I have successfully made WPS before, so I am not totally new, I just would like to move to "WPS Making 201" and am looking for study material. The goal here is to make themes to share with folks who love the look and function of the complicated themes, but can't easily see tiny fonts.

Thanks for the pointers.

P.S. These pages were a big help, but I am looking for more info.
http://www.rockbox.org/tw...in/SimpleGuideToWPSMaking and
http://www.rockbox.org/tw...i/bin/view/Main/CustomWPS

Some questions I have....

Can I force a line of text to a certain position (other than the normal line count up/down.) On my themes the last line is about 5 pixels too low and since there is not text in the line above, moving this line up wouldn't conflict with another.
Along the horizontal, can text be forced to a position (other than align left, right and center)

[bascule]

The Wiki will only have information related to a standard build. All information for WPS syntax for custom patches/builds will exist only in Flyspray or sometimes in the unsuported builds forum for the simple reason that, because it is non-standard, changes are likely to be more frequent as people develop patches.

Plus, as has been stated many times, Album Art and other graphical trickery is all awaiting Viewports functionality to be implemented and no interim solutions are likely to be committed. At that time the syntax will probably change significantly, anyway.

[HRM]

That makes perfect sense.

Perhaps it would be best if in the rockbox-themes.org page there is a "unsupported syntax" page where the various patch makers can list the syntax features that thier specific patch supports. I just see a need for a way to document the WPS syntax as it evolves in a central place.


If someone ever has time to post something I would be very happy to look through it. Until then I would like to thank everyone for all their hard work.

[Llorean]

The WPS syntax IS documented as it evolves: When something is included in the official build, it is added to the wiki.

As these are the Official forums, and not for discussion of unsupported builds anyway, that's the syntax we really should be concerning ourselves with here.

[HRM]

I know there is a huge issue with supported and unsupported things, but the rockbox-themes.org page has many popular themes that use unsupported builds. Isn't there a place for this info? I will post what I have competed and it can be moved or deleted or whatever, but those with zero knowledge do not see the simplicity of things as they stand. It is only those who understand who feel the info is simple to find. Some folks capable of creating WPS themes are not and never will be technically proficient.

EDIT: Here is the odd thing as I see it. There is huge discussions of patches and themes that use unsupported things, but there is no where to post about it. The Unsupported section rules say each build has one thread. I understand what a huge effort is needed to try and keep the efforts to supported builds so as not to waste resourses and so everyone is on the same page, but where does a question or info like this belong?

Last thoughts: I am trying to help people, not piss off the hard working moderators!

1) Please don't flood the forums reposting information in the Tracker. It's stated in the guidelines that the forums is NOT the place for documenting things. Especially when those things are features of Unsupported Builds.

How can one flood a forum that has 5 posts a day?

2) Do NOT double post, the EDIT button exists for a reason.

I had the second post ready and I got a warning screen about new info, I posted there and then posted the other one without thinking. I can see why this annoys folks but is it worth your time to mention really? A post in a forum at the top, can't really be bumped for any purpose. You could have noticed how I edited the title post twice also. It is pretty obvious that this was a double post by error, and your mentioning it wasn't really needed. Maybe it made you feel better though?

3) rockbox-themes.org is not at this time officially part of Rockbox, so I have no clue at all why you're asking us about something that you feel they should be doing.

This is the point exactly. I have no clue that this is the case until it is told to me. It may be hard to remember that everything that is simple to someone like yourself, is not self evident to new folks. I am a valuable member of many online communities and know how to behave. I am not sure everyone does but I know if I am frustrated by dealing with new folks and answering the same questions over and over (which I do) I take a breather and try not to make new folks feel unwelcome.

[HRM]

These pages were a big help, but I am looking for more info.
http://www.rockbox.org/tw...in/SimpleGuideToWPSMaking and
http://www.rockbox.org/tw...i/bin/view/Main/CustomWPS

At this point my skills are close to zero, but I am trying to organize things for other newbies. If anything is incorrect or left out, please feel free to correct me or add below (or moderate for clarity)
Included below are the commands that are available by using the current Chrisjs Build. It can be downloaded here: http://chrisjs.com/
Like with everything, it is simple once understood. The list is short, but maybe this will help others.

I am trying to include all the WPS patches as noted here: http://chrisjs.com/?page_id=22 . You find this info by following the patch itself to the appropriate flyspray page, then clicking the task page if it the info isn't already displayed.

__________________________________________________________________________________
FS#5900 - Custom WPS Line with x/y/width coordinates and font face/color settings (from here : http://www.rockbox.org/tracker/task/5900 )

Details
This patch adds a new tag in your wps which looks like this:
%e|11|219|50|1|B8C8E1|%alMusic

Details:
11 = x coordinate
219 = y coordinate
30 = width
1 = userfont1 (this is the font face for this line which is defined in the wps.cfg)
B8C8E1 = the color for the line

%al is the normal tag for aligning text to the left

NOTE1: It depends on the multifont-userfonts.patch
NOTE2: All values have to be specified none of them is optional.
NOTE3: %s (scrolling tag) is not working yet, but I hope to integrate it soon.

_____________________________________________________________________

FS#5899 - Custom List/Menu x/y coordinates and width (from here : http://www.rockbox.org/tracker/task/5899 )

Details
This patch adds four options to the rockbox wps settings file so you can define a custom x/y coordinate for the list/menu and even a width and a number of lines.

The seetings in the theme.cfg file should look like following:
listxpos: 47
listypos: 47
listlines: 9
listwidth: 210

(these are the settings for the jClix theme for e.g.)

This should help people to create custom wps-es and place the menus anywhere on the screen.

___________________________________________________________________________
FS#2954 - Scrolling text margin for the wps  from here : (http://www.rockbox.org/tracker/task/2954 )

Details
The patch adds the possibility to restrict the width of a (scrolling) line.
It enables you to position the scroll text inside the line and give him a
starting and ending position.
It extents the %s WPS tag to the following:
%s%m|x1|x2|
where x1 is the x-position where the line text starts and x2 is the
ending x-position of the scroll text (actually, when I look at the
code, it should also work for nonscrolling text...)
Only one margin is allowed per line
__________________________________________________________________________

[Llorean]

1) Please don't flood the forums reposting information in the Tracker. It's stated in the guidelines that the forums is NOT the place for documenting things. Especially when those things are features of Unsupported Builds.

2) Do NOT double post, the EDIT button exists for a reason.

3) rockbox-themes.org is not at this time officially part of Rockbox, so I have no clue at all why you're asking us about something that you feel they should be doing.

[mnhnhyouh]

Would it be possible to start a thread in the unsupported builds section, that somebody agrees to maintain, that keeps track of the wps commands used by various unsupported builds?

This would seem to me to provide a convenient solution that was a one stop shop, and was in a place where it would be easily found.

It could be as simple as a post that lists...

Album Art Resize - tdbrook, EvilG
Other patches - other unsupported builds...

Album Art Resize - list wps terms....
Other patches - list their terms as well.

As other patches are added to custom builds the builder, or others could add to the bottom of the thread and the maintainer could edit the first post to keep it current.

What do you think?

h