diff options
author | Frank Gevaerts <frank@gevaerts.be> | 2009-08-01 13:42:51 +0000 |
---|---|---|
committer | Frank Gevaerts <frank@gevaerts.be> | 2009-08-01 13:42:51 +0000 |
commit | 9bcc6701bf1689d3d06089b1d239f1ecfb9e9844 (patch) | |
tree | a700fb7ccb68c1fc10d646f2b23999b0625eaab0 | |
parent | d657c690a83656d38995b6d76e30747d9ffe0c24 (diff) | |
download | rockbox-9bcc6701bf1689d3d06089b1d239f1ecfb9e9844.tar.gz rockbox-9bcc6701bf1689d3d06089b1d239f1ecfb9e9844.zip |
Add png viewer plugin documentation
Author: Christophe Gouiran
Flyspray: FS#10475
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22092 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r-- | manual/plugins/main.tex | 2 | ||||
-rw-r--r-- | manual/plugins/pngviewer.tex | 96 |
2 files changed, 98 insertions, 0 deletions
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex index 1a684b1007..1a57fc96ef 100644 --- a/manual/plugins/main.tex +++ b/manual/plugins/main.tex | |||
@@ -137,6 +137,8 @@ the associated file. Viewers are stored in the | |||
137 | 137 | ||
138 | \opt{lcd_bitmap}{\opt{swcodec}{\input{plugins/mpegplayer.tex}}} | 138 | \opt{lcd_bitmap}{\opt{swcodec}{\input{plugins/mpegplayer.tex}}} |
139 | 139 | ||
140 | \opt{lcd_bitmap}{\opt{lcd_color}{\input{plugins/pngviewer.tex}}} | ||
141 | |||
140 | \opt{lcd_color}{\input{plugins/ppmviewer.tex}} | 142 | \opt{lcd_color}{\input{plugins/ppmviewer.tex}} |
141 | 143 | ||
142 | \opt{recorder,recorderv2fm,ondio}{\input{plugins/rockbox_flash.tex}} | 144 | \opt{recorder,recorderv2fm,ondio}{\input{plugins/rockbox_flash.tex}} |
diff --git a/manual/plugins/pngviewer.tex b/manual/plugins/pngviewer.tex new file mode 100644 index 0000000000..c205ac0666 --- /dev/null +++ b/manual/plugins/pngviewer.tex | |||
@@ -0,0 +1,96 @@ | |||
1 | % $Id: $id$ % | ||
2 | \subsection{PNG viewer} | ||
3 | Open a PNG file in the \setting{File Browser} to view it% | ||
4 | \opt{swcodec}{ | ||
5 | \note{When an audio file is playing the size of the image is limited as | ||
6 | the decoding process needs to share memory with audio tracks. To be able to | ||
7 | view a bigger file you may need to stop playback.} | ||
8 | } | ||
9 | \nopt{large_plugin_buffer}{% | ||
10 | \note{This plugin will cause playback to stop.}% | ||
11 | }% | ||
12 | |||
13 | \begin{table} | ||
14 | \begin{btnmap}{}{} | ||
15 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD% | ||
16 | ,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD} | ||
17 | {\ButtonUp\ / \ButtonDown}% | ||
18 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu\ / \ButtonPlay}% | ||
19 | \opt{IRIVER_H10_PAD}{\ButtonScrollUp\ / \ButtonScrollDown} % | ||
20 | / \ButtonLeft\ / \ButtonRight | ||
21 | \opt{HAVEREMOTEKEYMAP}{& } | ||
22 | & Move around in zoomed in image\\ | ||
23 | \opt{RECORDER_PAD}{\ButtonPlay} | ||
24 | \opt{ONDIO_PAD}{\ButtonMenu} | ||
25 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD% | ||
26 | ,SANSA_C200_PAD,MROBE100_PAD}{\ButtonSelect} | ||
27 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollFwd} | ||
28 | \opt{IRIVER_H10_PAD}{\ButtonPlay} | ||
29 | \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp} | ||
30 | \opt{HAVEREMOTEKEYMAP}{& } | ||
31 | & Zoom in\\ | ||
32 | \opt{RECORDER_PAD}{\ButtonOn} | ||
33 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonDown} | ||
34 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode} | ||
35 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonScrollBack} | ||
36 | \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{Long \ButtonSelect} | ||
37 | \opt{IRIVER_H10_PAD}{Long \ButtonPlay} | ||
38 | \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown} | ||
39 | \opt{MROBE100_PAD}{\ButtonPlay} | ||
40 | \opt{HAVEREMOTEKEYMAP}{& } | ||
41 | & Zoom out\\ | ||
42 | \opt{RECORDER_PAD}{\ButtonFThree} | ||
43 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight} | ||
44 | \opt{IRIVER_H100_PAD}{\ButtonOn} | ||
45 | \opt{IRIVER_H300_PAD}{\ButtonRec} | ||
46 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonRight} | ||
47 | \opt{IAUDIO_X5_PAD}{\ButtonPlay} | ||
48 | \opt{IRIVER_H10_PAD}{\ButtonFF} | ||
49 | \opt{SANSA_E200_PAD}{\ButtonScrollFwd} | ||
50 | \opt{SANSA_C200_PAD}{\ButtonVolUp} | ||
51 | \opt{GIGABEAT_PAD}{\ButtonA+\ButtonRight} | ||
52 | \opt{GIGABEAT_S_PAD}{\ButtonNext} | ||
53 | \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonRight} | ||
54 | \opt{HAVEREMOTEKEYMAP}{& } | ||
55 | & Next png in directory\\ | ||
56 | \opt{RECORDER_PAD}{\ButtonFTwo} | ||
57 | \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft} | ||
58 | \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonRec} | ||
59 | \opt{IRIVER_H300_PAD}{\ButtonOn} | ||
60 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonLeft} | ||
61 | \opt{IRIVER_H10_PAD}{\ButtonRew} | ||
62 | \opt{SANSA_E200_PAD}{\ButtonScrollBack} | ||
63 | \opt{SANSA_C200_PAD}{\ButtonVolDown} | ||
64 | \opt{GIGABEAT_PAD}{\ButtonA+\ButtonLeft} | ||
65 | \opt{GIGABEAT_S_PAD}{\ButtonPrev} | ||
66 | \opt{MROBE100_PAD}{\ButtonDisplay+\ButtonLeft} | ||
67 | \opt{HAVEREMOTEKEYMAP}{& } | ||
68 | & Previous png in directory\\ | ||
69 | \opt{SANSA_E200_PAD,SANSA_C200_PAD}{%currently only defined for the sansa pads | ||
70 | \ButtonRec | ||
71 | \opt{HAVEREMOTEKEYMAP}{& } | ||
72 | & Toggle slide show mode\\ | ||
73 | } | ||
74 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff} | ||
75 | \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonSelect+\ButtonMenu} | ||
76 | \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonPower} | ||
77 | \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu} | ||
78 | \opt{HAVEREMOTEKEYMAP}{& | ||
79 | \opt{IRIVER_RC_H100_PAD}{\ButtonRCStop} | ||
80 | } | ||
81 | & Show menu / Abort while decoding \\ | ||
82 | \end{btnmap} | ||
83 | \end{table} | ||
84 | |||
85 | The menu has the following entries. | ||
86 | \begin{description} | ||
87 | \item[Quit.] Quits the viewer and returns to the \setting{File Browser}. | ||
88 | \item[Toggle Slideshow Mode.] Enables or disables the slideshow mode. | ||
89 | \item[Change Slideshow Timeout.] You can set the timeout for the slideshow | ||
90 | between 1 second and 20 seconds. | ||
91 | \opt{large_plugin_buffer}{ | ||
92 | \item[Show Playback Menu.] From the playback menu you can control the | ||
93 | playback of the currently loaded playlist and change the volume of your \dap. | ||
94 | } | ||
95 | \item[Return.] Returns you to the image | ||
96 | \end{description} | ||