Rockbox

  • Status Closed
  • Percent Complete
    100%
  • Task Type Patches
  • Category Manual
  • Assigned To No-one
  • Operating System Sansa Fuze+
  • Severity Low
  • Priority Very Low
  • Reported Version Release 3.10
  • Due in Version Undecided
  • Due Date Undecided
  • Votes
  • Private
Attached to Project: Rockbox
Opened by Jean-Louis Biasini - 2011-12-28
Last edited by Dominik Riebeling - 2012-02-27

FS#12492 - add fuze+ manual

I’m starting to write fuze+’s manual
for the moment only the image files (png and pdf) should be uploaded to the server, as they cannot be diffed and are ready however
the patch is given as a sources to comment/helps untill it is fully ready.

Closed by  Dominik Riebeling
2012-02-27 07:22
Reason for closing:  Out of Date
Additional comments about closing:  

closing this since the relevant patches are now on gerrit.

Jean-Louis Biasini commented on 2011-12-30 02:02

Ok I did have to change the image. More section linked/implemented.

Dominik Riebeling commented on 2011-12-30 22:32

Do we have an svg source for the pdf and png images?

Jean-Louis Biasini commented on 2011-12-31 00:21

it in my patch!

Jean-Louis Biasini commented on 2011-12-31 02:31

So I must be pretty closed now:
-images
-keymaps

anyhow i’m stuck for the manual won’t compile. it end up with error even other manual seems to be broken and I don’t know why. Please help!

Jean-Louis Biasini commented on 2011-12-31 16:27

Ok I will post a new file soon: I’ve forget a lot of file…

Jean-Louis Biasini commented on 2011-12-31 18:31

- I corrected some stuff.
- implemented some missing section / /opt

Problem remaining (please help it’s very difficult for me to find out! I just spend my whole day on it)
- quite a lot of reference do not get defined correctly, no Idea why. Typical message (I get tenth and tenth of that kind on different References):
LaTeX Warning: Reference `ref:Supportedaudioformats’ on page 186 undefined on input line 104.

- Probably related to the previous: table of contents do not build anymore and chapter are not recognized anymore

- 3 compilation error when make manual-zip (seems to be the only mode that stop on all critical errors:
1) (appears 2 times one after the other)

  ) (./configure_rockbox/display_options.tex [77] [78] [79] [80])
  (./configure_rockbox/system_options.tex [81]
  LaTeX Warning: Reference `ref:IdlePoweroffSetting' on page 82 undefined on inpu
  t line 150.
 [82] [83]
 ! LaTeX Error: There's no line here to end.
 See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
...                                              
                                                
l.717 }
     

2)

  [160]) (./plugins/text_viewer.tex
  l.2 --- TeX4ht warning --- Cannot determine size of graphic in plugins/images/s
  s-text_viewer-main-240x320x16.png (no BoundingBox) ---
  LaTeX Warning: Reference `ref:Contextmenu' on page 161 undefined on input line 
  8.
  [161]
  LaTeX Warning: Reference `ref:Defaultcodepage' on page 162 undefined on input line 220.
  [162]
  LaTeX Warning: Reference `ref:configure_rockbox_themes' on page 163 undefined on input line 265.
  [163]
  ! LaTeX Error: Too deeply nested.
  See the LaTeX manual or LaTeX Companion for explanation.
  Type  H <return>  for immediate help.
   ...                                              
                                                
  l.274                             \item
                                         [No] Do not display the horizontal sc...

3)
(./appendix/fdl.tex [278] [279] [280] [281] [282] [283] [284] [285] [286]
[287]) [288] (./appendix/gpl-2.0.tex [289] [290] [291] [292] [293] [294]
[295] [296] [297]))

! LaTeX Error: \begin{enumerate} on input line 61 ended by \end{document}.

See the LaTeX manual or LaTeX Companion for explanation.
Type H <return> for immediate help.

                                                

l.26 \end{document}

Jean-Louis Biasini commented on 2011-12-31 19:57

Oh this patch doesn’t contain the 3 new files! I will have to post a new one soon!

Jean-Louis Biasini commented on 2011-12-31 21:43

here is the complete patch (the 3 image files uploaded with patch v5 are still to download to manual/rockbox_interface/images)

Jean-Louis Biasini commented on 2012-01-01 03:21

- So I was finally able to have it working! I also started a few correction. We have now to read and rearrange all the little stuff. But first I think that bluebrother want to have a look to it for the “do it right” policy. So I would wait before to go further on this.
- For those who want to test work on it: the 3 images files go into manual/rockbox_interface/images
- bluebrother: it would be nice to use the svg unstead of the png uploaded for the theme site. It would be also good to open a dedicated section for current-build for the fuze+.

Dominik Riebeling commented on 2012-01-01 10:16

I’ve committed the platform files and images. This should make it much easier to work on this patch.

- There’s no need to add keyword lines. With the upcoming transition to git those won’t be used anymore.
- Instead of changing the config header to avoid problems with missing keys just define those keys as \fixme{tbd}. We had it this way in the past, and we shouldn’t rely on changing the config header just to make the manual build.

Jean-Louis Biasini commented on 2012-01-01 13:19

the manual would build in both case but with section for stuff are not supported by now.

Jean-Louis Biasini commented on 2012-01-01 13:36

but you’re right that those patch shouldn’t rely one on the other anyway. I will move this patch away

Jean-Louis Biasini commented on 2012-01-01 15:22

-so after the last update info: new patch to have the manual compiling with actual svn and the content I already made. I have already read untill the end of the installation process.
-I someone want to help it would be nice to read the part from plugins/demo untill the end
-While reading be aware that some keymaps are going to be update by this patch http://www.rockbox.org/tracker/task/12405#comment42046 the manual intent to follow this update and therefore is not always consistent with what is in svn by now.

Jean-Louis Biasini commented on 2012-01-02 03:16

so tonight update corrections implemented rereading untill p 67

Jean-Louis Biasini commented on 2012-01-02 03:16

oups file…

Jean-Louis Biasini commented on 2012-01-03 01:46

new update… plugins nightmare started…

Jean-Louis Biasini commented on 2012-01-04 01:47

All plugins game documented.

Dominik Riebeling commented on 2012-01-06 20:44

- The patch changes the blackjack plugin.
- The patch removes the mpiohd200 instruction from the installation.
- The installation instructions should not talk about “OF”. Someone installing Rockbox for the first time might not be familiar with that abbreviation.
- IMO deep-linking a firmware file directly on a 3rd party server is a bad idea. We should link to a page that allows the user to find the file by himself (in this case, the Sandisk Forums) instead.

Also, please split out the plugin changes as smaller patches are easier (and obviously faster) to review.

Jean-Louis Biasini commented on 2012-01-07 19:12

- blackjack plugin modification reùoved
- mpiohd200 removal solved
- regarding “OF” occurence in my IMX233_install.tex, it is starting with: An original firmware (OF) from \playerman’s website” so the abrieviation is explained. If this is still not acceptable then we also have to correct the sansaAMS_install.tex file which is using the very same sentence.
- sansa link to OF has been changed to the fuzeplus section of the sansa forum site
- patch spitted between main and plugins (games)

Jean-Louis Biasini commented on 2012-01-07 19:14

no idea why I get those ypr0 file edited, so remove that from main

Jean-Louis Biasini commented on 2012-01-07 19:15
amaury pouly commented on 2012-01-15 00:46

Should I commit that or is there some more work to do ? Does that need to disable features like recording and fm before ?

Jean-Louis Biasini commented on 2012-01-15 13:17

in my opinion fuzeplus-manual-plugins-games-v1.diff (see above) and fuzeplus-manual-main-v15.diff are ready to commit. I trying to have bluebrother opinion again on this since a week as I corrected the patch following his direction above - no success he seems to be too busy for now.

Jean-Louis Biasini commented on 2012-01-16 16:30

- \ButtonPlayPause updated to \ButtonPlay

MichaelGiacomelli commented on 2012-01-16 21:13

You can take a look at how other people break up patches if you need an example:

http://www.rockbox.org/irc/log-20120104#07:33:51 http://www.rockbox.org/irc/log-20120103#05:31:13 http://www.rockbox.org/irc/log-20120104#06:21:33

Each functional change gets its own patch so that the commit history is as clear as possible. If subsequent patches go together logically, you simply submit them at the same time.

Jean-Louis Biasini commented on 2012-01-16 21:54

Thanks for those explaination. So new try…

Jean-Louis Biasini commented on 2012-02-21 19:01

- all patches have been updated to the actual code (I nearly had to rewrite the plugins game one totally)
- there was still a bunch of errors that I corrected
- I splitted the correction of \ButtonPlayPause on a separated patch for simplicity
- I uploaded everything on git

Please do comment/commit I don’t want to have to rewrite the plugin patch a third time!

Loading...

Available keyboard shortcuts

Tasklist

Task Details

Task Editing