Rockbox

This is the bug/patch tracker for Rockbox. Click here for more information.

Quick links: Bugs · Patches · Rockbox frontpage

Tasklist

FS#10553 - Viewports are not in the manual

Attached to Project: Rockbox
Opened by David Kauffmann (BdN3504) - Saturday, 22 August 2009, 01:44 GMT+2
Last edited by Alex Parker (BigBambi) - Sunday, 20 September 2009, 18:58 GMT+2
Task Type Bugs
Category Manual
Status Closed
Assigned To No-one
Player Type All players
Severity Low
Priority Normal
Reported Version Version 3.3
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Private No

Details

Let's change this. here's a first effort i have been working on for three nights now. Please help me fix the \opts, i can't figure out how to use them in combination with {example}, that's why i put the examples in their own files.
This task depends upon

Closed by  Alex Parker (BigBambi)
Sunday, 20 September 2009, 18:58 GMT+2
Reason for closing:  Accepted
Additional comments about closing:  Accepted as part of r22756 - thanks!
Comment by David Kauffmann (BdN3504) - Saturday, 22 August 2009, 01:44 GMT+2
oops, forgot the file. here it is.
   viewports-manual.patch (10.5 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex   |   15 ++
 manual/advanced_topics/viewports/colour-conditional.tex    |   15 ++
 manual/advanced_topics/viewports/mono-conditional.tex      |   12 ++
 manual/advanced_topics/viewports/colour-vp-syntax.tex      |   15 ++
 manual/advanced_topics/viewports/grayscale-conditional.tex |   15 ++
 manual/advanced_topics/viewports/mono-vp-syntax.tex        |   13 ++
 manual/advanced_topics/main.tex                            |   77 +++++++++++--
 manual/appendix/wps_tags.tex                               |    2 
 8 files changed, 152 insertions(+), 12 deletions(-)

Comment by David Kauffmann (BdN3504) - Saturday, 22 August 2009, 01:58 GMT+2
fixed this myself. comittable in my eys, you got anything to add?
   viewports-manual.patch (10.5 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex   |   15 ++
 manual/advanced_topics/viewports/colour-conditional.tex    |   15 ++
 manual/advanced_topics/viewports/mono-conditional.tex      |   12 +
 manual/advanced_topics/viewports/colour-vp-syntax.tex      |   15 ++
 manual/advanced_topics/viewports/grayscale-conditional.tex |   15 ++
 manual/advanced_topics/viewports/mono-vp-syntax.tex        |   13 ++
 manual/advanced_topics/main.tex                            |   79 +++++++++++--
 manual/appendix/wps_tags.tex                               |    2 
 8 files changed, 154 insertions(+), 12 deletions(-)

Comment by David Kauffmann (BdN3504) - Saturday, 22 August 2009, 13:12 GMT+2
fixed problems as discussed in irc.
   viewports-manual.patch (12 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex       |   26 +++++
 manual/advanced_topics/viewports/charcell-vp-syntax.tex        |   23 ++++
 manual/advanced_topics/viewports/colour-conditional.tex        |   15 ++
 manual/advanced_topics/viewports/colour-no-rtc-conditional.tex |   13 ++
 manual/advanced_topics/viewports/colour-vp-syntax.tex          |   26 +++++
 manual/advanced_topics/viewports/grayscale-conditional.tex     |   13 ++
 manual/advanced_topics/viewports/charcell-conditional.tex      |   12 ++
 manual/advanced_topics/main.tex                                |   51 +++++++++-
 manual/appendix/wps_tags.tex                                   |    2 
 9 files changed, 175 insertions(+), 6 deletions(-)

Comment by David Kauffmann (BdN3504) - Saturday, 22 August 2009, 13:32 GMT+2
forgot to remove a paranthesis which broke a table: update!
   viewports-manual.patch (10.6 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex       |   26 +++++
 manual/advanced_topics/viewports/charcell-vp-syntax.tex        |   23 ++++
 manual/advanced_topics/viewports/colour-conditional.tex        |   15 ++
 manual/advanced_topics/viewports/colour-no-rtc-conditional.tex |   13 ++
 manual/advanced_topics/viewports/colour-vp-syntax.tex          |   26 +++++
 manual/advanced_topics/viewports/grayscale-conditional.tex     |   13 ++
 manual/advanced_topics/viewports/charcell-conditional.tex      |   12 ++
 manual/advanced_topics/main.tex                                |   51 +++++++++-
 manual/appendix/wps_tags.tex                                   |    2 
 9 files changed, 175 insertions(+), 6 deletions(-)

Comment by Thomas Martitz (kugel.) - Saturday, 22 August 2009, 14:23 GMT+2
It seems you mixed up charcell and monochrome displays. charcell doesn't have wps-viewports or ui-viewports at all.

I also think that it's a poor choice to have the RTC stuff in the example, the additional file it needs isn't worth it.

I'd like to see an example for an "ordinary" unlabeled viewport as well.
Comment by David Kauffmann (BdN3504) - Monday, 24 August 2009, 10:51 GMT+2
removed rtc, excluded charcell.
   Viewports-Manual.patch (10.4 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex   |   28 +++++++
 manual/advanced_topics/viewports/colour-conditional.tex    |   15 ++++
 manual/advanced_topics/viewports/mono-conditional.tex      |   13 +++
 manual/advanced_topics/viewports/colour-vp-syntax.tex      |   28 +++++++
 manual/advanced_topics/viewports/grayscale-conditional.tex |   15 ++++
 manual/advanced_topics/viewports/mono-vp-syntax.tex        |   28 +++++++
 manual/advanced_topics/main.tex                            |   46 +++++++++++--
 7 files changed, 168 insertions(+), 5 deletions(-)

Comment by David Kauffmann (BdN3504) - Thursday, 27 August 2009, 20:32 GMT+2
Committable?
   viewports-manual-01.patch (10.3 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex   |   26 ++++++
 manual/advanced_topics/viewports/colour-conditional.tex    |   15 +++
 manual/advanced_topics/viewports/mono-conditional.tex      |   13 +++
 manual/advanced_topics/viewports/colour-vp-syntax.tex      |   25 ++++++
 manual/advanced_topics/viewports/grayscale-conditional.tex |   15 +++
 manual/advanced_topics/viewports/mono-vp-syntax.tex        |   23 +++++
 manual/advanced_topics/main.tex                            |   51 +++++++++++--
 manual/appendix/wps_tags.tex                               |    2 
 8 files changed, 164 insertions(+), 6 deletions(-)

Comment by Jonas Häggqvist (rasher) - Thursday, 27 August 2009, 23:39 GMT+2
It's a good idea to search the tracker before writing up something. Anyway,  FS#9934  might have something usable. If not, it should be closed and replaced by this.
Comment by David Kauffmann (BdN3504) - Friday, 28 August 2009, 00:14 GMT+2
Good idea indeed. i vaguely remember having searched and did not get any results... well anyways, i have attached a preview, and also updated to the new rbtabular already in last post. please point out any problems, if you find them.
(application/pdf)    Viewports-Preview.pdf (432.2 KiB)
Comment by David Kauffmann (BdN3504) - Friday, 28 August 2009, 00:22 GMT+2
forgot a closing paranthesis. broke the table for grayscale targets. update.
   viewports-manual-01.patch (10.3 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex   |   26 ++++++
 manual/advanced_topics/viewports/colour-conditional.tex    |   15 +++
 manual/advanced_topics/viewports/mono-conditional.tex      |   13 +++
 manual/advanced_topics/viewports/colour-vp-syntax.tex      |   25 ++++++
 manual/advanced_topics/viewports/grayscale-conditional.tex |   15 +++
 manual/advanced_topics/viewports/mono-vp-syntax.tex        |   23 +++++
 manual/advanced_topics/main.tex                            |   51 +++++++++++--
 manual/appendix/wps_tags.tex                               |    2 
 8 files changed, 164 insertions(+), 6 deletions(-)

Comment by David Kauffmann (BdN3504) - Friday, 28 August 2009, 00:27 GMT+2
and the proper preview. man i don't think that there has ever been someone coding so many errors into such a simple document.
(application/pdf)    viewports-preview.pdf (1.64 MiB)
Comment by David Kauffmann (BdN3504) - Tuesday, 01 September 2009, 10:41 GMT+2
Changed the wording slightly in grayscale conditional. Added a line about the end of viewports.
   viewports-manual-final.patch (10.3 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex   |   26 ++++++
 manual/advanced_topics/viewports/colour-conditional.tex    |   15 +++
 manual/advanced_topics/viewports/mono-conditional.tex      |   13 +++
 manual/advanced_topics/viewports/colour-vp-syntax.tex      |   25 ++++++
 manual/advanced_topics/viewports/grayscale-conditional.tex |   15 +++
 manual/advanced_topics/viewports/mono-vp-syntax.tex        |   23 +++++
 manual/advanced_topics/main.tex                            |   52 +++++++++++--
 manual/appendix/wps_tags.tex                               |    2 
 8 files changed, 165 insertions(+), 6 deletions(-)

Comment by David Kauffmann (BdN3504) - Wednesday, 09 September 2009, 19:51 GMT+2
Added the UIviewports part.
Added %V tag to wps tags.
Fixed some minor glitches (no %s after opts, removed the obsolete %P tag in the WPS tags)
   UIVPmanual.patch (17.3 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex   |   26 ++++
 manual/advanced_topics/viewports/colour-conditional.tex    |   15 ++
 manual/advanced_topics/viewports/colour-uivp-syntax.tex    |    6 +
 manual/advanced_topics/viewports/mono-conditional.tex      |   13 ++
 manual/advanced_topics/viewports/colour-vp-syntax.tex      |   25 ++++
 manual/advanced_topics/viewports/grayscale-conditional.tex |   15 ++
 manual/advanced_topics/viewports/mono-uivp-syntax.tex      |    5 
 manual/advanced_topics/viewports/grayscale-uivp-syntax.tex |    6 +
 manual/advanced_topics/viewports/mono-vp-syntax.tex        |   23 ++++
 manual/advanced_topics/main.tex                            |   73 ++++++++++++-
 manual/appendix/wps_tags.tex                               |   60 +++++++++-
 11 files changed, 253 insertions(+), 14 deletions(-)

Comment by David Kauffmann (BdN3504) - Wednesday, 09 September 2009, 20:00 GMT+2
Oops, wrong commit last time: somehow copypasta did me wrong.
   UIVPmanual.patch (16.2 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex   |   26 ++++
 manual/advanced_topics/viewports/colour-conditional.tex    |   15 ++
 manual/advanced_topics/viewports/colour-uivp-syntax.tex    |    6 +
 manual/advanced_topics/viewports/mono-conditional.tex      |   13 ++
 manual/advanced_topics/viewports/colour-vp-syntax.tex      |   25 ++++
 manual/advanced_topics/viewports/grayscale-conditional.tex |   15 ++
 manual/advanced_topics/viewports/mono-uivp-syntax.tex      |    5 
 manual/advanced_topics/viewports/grayscale-uivp-syntax.tex |    6 +
 manual/advanced_topics/viewports/mono-vp-syntax.tex        |   23 ++++
 manual/advanced_topics/main.tex                            |   73 ++++++++++++-
 manual/appendix/wps_tags.tex                               |   37 ++++--
 11 files changed, 230 insertions(+), 14 deletions(-)

Comment by Alex Parker (BigBambi) - Wednesday, 16 September 2009, 13:34 GMT+2
I'll try and have a proper look later, but a couple of immediate thoughts: "'s" is the possessive, "s" is the plural so in my opinion it should be |s not |'s - perhaps we can find a way to rephrase this slightly to avoid the issue :)

fgcolor and bgcolor - I know on the wiki it is like this, but it seems a little odd not to change them to fgcolour and bgcolour - they are just place holders showing you where to put other values, and I can't see any reason to keep them with the US spelling instead of the correct (for the manual) UK..

There are a couple of other minor things like "the blanks fields" should be "the blank fields", but as I say I'll look properly later.

Either way, good effort thus far :)
Comment by David Kauffmann (BdN3504) - Friday, 18 September 2009, 04:20 GMT+2
thanks for the love.
fixed these small issues. had to think alot about what you were refering to with |'s, simply replaced "-'s" with "hyphens".
Also, if you take a look at it, please take investigate in the repeat states. i took out an opt there because i don't think a-b is restricted to any player. i can be wrong, but i asked this question on IRC several times and no one answered, so i simply took the initiative.
   UIVPmanual.1.1.patch (17.3 KiB) 
 manual/advanced_topics/viewports/grayscale-vp-syntax.tex   |   26 ++++
 manual/advanced_topics/viewports/colour-conditional.tex    |   15 ++
 manual/advanced_topics/viewports/colour-uivp-syntax.tex    |    6 +
 manual/advanced_topics/viewports/mono-conditional.tex      |   13 ++
 manual/advanced_topics/viewports/colour-vp-syntax.tex      |   25 ++++
 manual/advanced_topics/viewports/grayscale-conditional.tex |   15 ++
 manual/advanced_topics/viewports/mono-uivp-syntax.tex      |    5 
 manual/advanced_topics/viewports/grayscale-uivp-syntax.tex |    6 +
 manual/advanced_topics/viewports/mono-vp-syntax.tex        |   23 +++
 manual/advanced_topics/main.tex                            |   75 ++++++++++++-
 manual/appendix/wps_tags.tex                               |   37 ++++--
 11 files changed, 232 insertions(+), 14 deletions(-)

Comment by Thomas Martitz (kugel.) - Friday, 18 September 2009, 09:31 GMT+2
Taking the initiative is good, but in a separate patch please.

Loading...