This is the bug/patch tracker for Rockbox. Click here for more information.
Quick links: Bugs · Patches · Rockbox frontpage
FS#12492 - add fuze+ manual
Attached to Project:
Rockbox
Opened by Jean-Louis Biasini (JeanLouisBiasini) - Thursday, 29 December 2011, 00:49 GMT+2
Last edited by Dominik Riebeling (bluebrother) - Monday, 27 February 2012, 08:22 GMT+2
Opened by Jean-Louis Biasini (JeanLouisBiasini) - Thursday, 29 December 2011, 00:49 GMT+2
Last edited by Dominik Riebeling (bluebrother) - Monday, 27 February 2012, 08:22 GMT+2
|
DetailsI'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. 
sansafuzeplus-front.pdf
(22.4 KiB)
sansafuzeplus-front.png
(61.6 KiB)
fuzeplus-manual-v1.diff
(100.5 KiB)
manual/platform/sansafuzeplus.tex | 28 manual/platform/keymap-sansafuzeplus.tex | 114 + manual/getting_started/installation.tex | 38 manual/getting_started/IMX233_install.tex | 83 manual/rockbox_interface/images/sansafuzeplus-front.svg | 1439 ++++++++++++++++ 5 files changed, 1685 insertions(+), 17 deletions(-) |
This task depends upon
Closed by Dominik Riebeling (bluebrother)
Monday, 27 February 2012, 08:22 GMT+2
Reason for closing: Out of Date
Additional comments about closing: closing this since the relevant patches are now on gerrit.
Monday, 27 February 2012, 08:22 GMT+2
Reason for closing: Out of Date
Additional comments about closing: closing this since the relevant patches are now on gerrit.
-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!
- 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}
- 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+.
- 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.
-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.
- 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.
- 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)
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.
- 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!