[Rhythmbox-devel] Updated help documentation
- From: Mark Humphreys <mmarquee btinternet com>
- To: Rhythmbox Mailing List <rhythmbox-devel gnome org>
- Subject: [Rhythmbox-devel] Updated help documentation
- Date: Sun, 14 Sep 2003 22:33:10 +0100
Hi all,
Attached is a updated set of documentation that solves an XML formatting
problem, gets the shortcuts in alphabetic order, a general clean up,
together with a few other changes.
Cheers,
Mark H.
--
? help/C/figures/rb-prefs-general.png
? help/C/figures/rb-prefs-library.png
? help/C/figures/rb-small-player.png
? help/C/figures/rb-tooltip.png
? rhythmdb/test-rhythmdb-indexing
? rhythmdb/test-rhythmdb-query
? rhythmdb/test-rhythmdb-simple
? rhythmdb/test-rhythmdb-tree-deserialization
? rhythmdb/test-rhythmdb-tree-serialization
Index: help/C/quick-reference.xml
===================================================================
RCS file: /cvs/gnome/rhythmbox/help/C/quick-reference.xml,v
retrieving revision 1.4
diff -r1.4 quick-reference.xml
13a14
>
17c18
< <keycombo><keycap>Ctrl</keycap><keycap>N</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>A</keycap></keycombo>
18a20
>
21c23
< <para>New group</para>
---
> <para>Select All</para>
23a26
>
27c30
< <keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>E</keycap></keycombo>
32c35
< <para>Add to library</para>
---
> <para>Extract CD</para>
34a38
>
38c42
< <keycombo><keycap>Ctrl</keycap><keycap>Q</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>J</keycap></keycombo>
43c47
< <para>Quit application</para>
---
> <para>Jump to playing song</para>
47d50
<
51c54,64
< <keycombo><keycap>Ctrl</keycap><keycap>P</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>N</keycap></keycombo>
> </shortcut>
> </entry>
> <entry>
> <para>New group</para>
> </entry>
> </row>
> <row>
> <entry>
> <shortcut>
> <keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>
56c69
< <para>Properties</para>
---
> <para>Add to library</para>
63c76
< <keycombo><keycap>Ctrl</keycap><keycap>J</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>P</keycap></keycombo>
68c81
< <para>Jump to playing song</para>
---
> <para>Properties</para>
71a85
>
75c89
< <keycombo><keycap>Ctrl</keycap><keycap>A</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>R</keycap></keycombo>
80c94
< <para>Select All</para>
---
> <para>Restart</para>
87c101
< <keycombo><keycap>Ctrl</keycap><keycap>Space</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo>
92c106
< <para>Play / Pause</para>
---
> <para>Shuffle play</para>
99c113
< <keycombo><keycap>Ctrl</keycap><keycap>Left</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>W</keycap></keycombo>
104c118
< <para>Previous Track</para>
---
> <para>Exit &application;</para>
107a122
>
111c126
< <keycombo><keycap>Ctrl</keycap><keycap>Right</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>Space</keycap></keycombo>
116c131
< <para>Next Track</para>
---
> <para>Play / Pause</para>
123c138
< <keycombo><keycap>Ctrl</keycap><keycap>R</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>Left</keycap></keycombo>
128c143
< <para>Restart</para>
---
> <para>Previous Track</para>
135c150
< <keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo>
---
> <keycombo><keycap>Ctrl</keycap><keycap>Right</keycap></keycombo>
140c155
< <para>Shuffle play</para>
---
> <para>Next Track</para>
165a181,190
> <row>
> <entry>
> <shortcut>
> <keycap>F8</keycap>
> </shortcut>
> </entry>
> <entry>
> <para>Toggle small display mode</para>
> </entry>
> </row>
176a202,258
>
> </tbody>
> </tgroup>
> </informaltable>
> </sect1>
> <sect1 id="multimedia-keys">
> <title>Multimedia Keys</title>
>
> <informaltable frame="none">
> <tgroup cols="2" colsep="0" rowsep="0">
> <colspec colname="COLSPEC0" colwidth="30*"/>
> <colspec colname="COLSPEC1" colwidth="70*"/>
> <tbody>
>
> <row>
> <entry>
> <shortcut>
> <keycap>Stop</keycap>
> </shortcut>
> </entry>
> <entry>
> <para>Stops the player</para>
> </entry>
> </row>
>
> <row>
> <entry>
> <shortcut>
> <keycap>Pause / Play</keycap>
> </shortcut>
> </entry>
> <entry>
> <para>Pauses / Play the player</para>
> </entry>
> </row>
>
> <row>
> <entry>
> <shortcut>
> <keycap>Prev</keycap>
> </shortcut>
> </entry>
> <entry>
> <para>Plays the previous played track</para>
> </entry>
> </row>
>
> <row>
> <entry>
> <shortcut>
> <keycap>Next</keycap>
> </shortcut>
> </entry>
> <entry>
> <para>Plays the next track</para>
> </entry>
> </row>
Index: help/C/user-guide.xml
===================================================================
RCS file: /cvs/gnome/rhythmbox/help/C/user-guide.xml,v
retrieving revision 1.6
diff -r1.6 user-guide.xml
21c21
< Callouts: Menubar, Toolbar, Player area, View pane, Side pane,
---
> Callouts: Menubar, Player area, View pane, Side pane,
47,51d46
< <entry valign="top">Toolbar</entry>
< <entry valign="top">Contains buttons that you use to
< perform quick tasks in &application;.</entry>
< </row>
< <row>
53,54c48
< <entry valign="top">Enable you to switch between Library
< and Groups.</entry>
---
> <entry valign="top">Enable you to switch between Library and &playlist;.</entry>
67,69c61,63
< <listitem><para>Music groups</para></listitem><!--
< <listitem><para>Audio CDs</para></listitem>
< <listitem><para>Internet radio</para></listitem> -->
---
> <listitem><para>Music groups</para></listitem>
> <!-- <listitem><para>Audio CDs</para></listitem> -->
> <listitem><para>Internet radio</para></listitem>
84,110d77
< <sect2 id="intro-toolbar">
< <title>The Toolbar</title>
< <screenshot>
< <mediaobject>
< <imageobject>
< <imagedata fileref="figures/rb-toolbar.png"
< format="PNG"/>
< </imageobject>
< <textobject>
< <phrase>Shows default &application; toolbar.</phrase>
< </textobject>
< </mediaobject>
< </screenshot>
< <para>The &application; toolbar provides easy access to functions
< used for playing tracks. From here it is possible to Play the
< currently selected track, Skip to a previous or next track, Pause
< a playing track, or select 'shuffle' play.
< </para>
< <para>It also shows the volume control, which is described
< <link linkend="volume">later</link>.
< </para>
< <note>
< <para>The layout of the toolbar can be customized, see
< <xref linkend="toolbar-edit"/></para>
< </note>
< </sect2>
<
120c87
< <phrase>Shows side pane with library and group icons.
---
> <phrase>Shows side pane with library and &playlist; icons.
125,126c92,93
< <para>The side pane is where you can access your music library and
< your groups <!-- and CDs -->.The side pane can contain
---
> <para>The side pane is where you can access your music library internet radio and
> your &playlist; <!-- and CDs -->.The side pane can contain
132,133c99
< <listitem>Any groups that have been created from imported
< songs.
---
> <listitem>Any &playlist; that have been created from imported songs.
134a101
> <listitem>Listen to Internet Radio stations.</listitem>
166,168d132
< <para>Clicking on the 'played time' will toggle between 'played time,
< 'time left' and 'total time'.
< </para>
203c167
< <phrase>Shows shuffle button in toolbar.
---
> <phrase>Shows shuffle button in statusbar.
208c172
< <para>When this button is pressed, the tracks in the
---
> <para>When this option is selected, the tracks in the
213d176
< <!--
223c186
< <phrase>Shows repeat button in toolbar.
---
> <phrase>Shows repeat button in statusbar.
228c191
< <para>When this button is pressed, when the last track in the
---
> <para>When this option is selected, when the last track in the
232d194
< -->
235c197
< <title>Next/Previous</title>
---
> <title>Next/Play/Previous</title>
248,252c210,212
< <para>These buttons can be used to skip between tracks
< whilst playing. The previous button will restart the
< song if it's been playing for a while, or skip to
< previous if at the start of a track (within first 2
< seconds).
---
> <para>The Next and Previous buttons can be used to skip between tracks
> whilst playing. If a song is currently playing, the previous button will restart the
> song. Clicking on the Play button will start &application; playing the current track. Whilst playing this will change to a Pause icon.
262c222
< <imagedata fileref="figures/rb-volume-mute.png"
---
> <imagedata fileref="figures/rb-volume-changer.png"
271,275c231
< <para>The volume of playback can be adjusted using the
< volume slider in the top right hand of the view.
< Sliding the to the right will increase the volume,
< whilst to the left will reduce it. The loudspeaker icon
< will change to indicate the relative volume.
---
> <para>volume control in the right hand of the player area. Clicking on the loudspeaker icon will show the volume slider. Sliding this up and down will increase and decrease the volume. The loudspeaker icon will change to reflect the relative volume.
277,282d232
< <note>
< <para>To mute the sound, click on the
< loudspeaker icon, and to restore the muted
< sound, do likewise.</para>
< </note>
<
294c244
< can play it directly or add it to a group to be played as
---
> can play it directly or add it to a &playlist; to be played as
297,299c247,248
< <para>When &application; is first started, there will be
< no entries Library. Choose <menuchoice><guimenu>Organize</guimenu><guimenuitem>Add to Library...</guimenuitem></menuchoice> to add
< music files to &application; Library. If you select a folder,
---
> <para>Choose <menuchoice><guimenu>Organize</guimenu><guimenuitem>Add to Library...
> </guimenuitem></menuchoice> to add music files to &application; Library. If you select a folder,
327c276,287
< with &application;
---
> with &application;, using the context menu.
> <screenshot>
> <mediaobject>
> <imageobject>
> <imagedata fileref="figures/rb-context-menu.png"
> format="PNG"/>
> </imageobject>
> <textobject>
> <phrase>The &application; context menu in Nautilus.</phrase>
> </textobject>
> </mediaobject>
> </screenshot>
349c309
< track. It is not shown when viewing a group<!-- or
---
> track. It is not shown when viewing a &playlist;<!-- or
427c387
< <para>&application; can maintain statistics on the use of the library. &application; automatically records the number of plays, the last played date and allows you to rating each track. You can access this information through <guilabel>Additional</guilabel> tab in <xref linkend="properties"/> dialog for each song or directly in the View Pane for all songs displayed in Library or groups; you can add proper columns via the <xref linkend="prefs"/> dialog.</para>
---
> <para>&application; can maintain statistics on the use of the library. &application; automatically records the number of plays, the last played date and allows you to rating each track. You can access this information through <guilabel>Additional</guilabel> tab in <xref linkend="properties"/> dialog for each song or directly in the View Pane for all songs displayed in Library or &playlist;; you can add proper columns via the <xref linkend="prefs"/> dialog.</para>
445c405
< <listitem><para>Select the song, choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Properties</guimenuitem></menuchoice>, select <guilabel>Details</guilabel> tab, click in different part of <guilabel>Rating</guilabel> entry [??] to set required rating</para></listitem>
---
> <listitem><para>Select the song, choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Properties</guimenuitem></menuchoice>, select <guilabel>Details</guilabel> tab, click in different part of <guilabel>Rating</guilabel> entry to set required rating</para></listitem>
462c422
< <title>Groups</title>
---
> <title>Playlists</title>
464c424
< <para>A group is a 'playlist' that has been created from songs in &application; library, to have a different sorting method from artist/album library default.
---
> <para>A &playlist; is an ad hoc list that has been created from songs in &application; library, to have a different sorting method from artist/album library default.
466c426
< <para>It might consist of a groups of songs of a particular 'genre', a specific group of artists, or even songs that are of a particular 'mood', or whatever you want.</para>
---
> <para>It might consist of a list of songs of a particular 'genre', a specific group of artists, or even songs that are of a particular 'mood', or whatever you want.</para>
468c428
< <para>To display a group, simply click on the required group's icon in side pane, and the view pane will change to show the contents.</para>
---
> <para>To display the contents of a &playlist;, simply click on the required icon in side pane, and the view pane will change to show the contents.</para>
473c433
< <para>To create a group use one of the following methods:</para>
---
> <para>To create a &playlist; use one of the following methods:</para>
477c437
< Drag a 'track', 'album' or 'artist' from library or library browser to the side pane. When the group is created, it will default to either the name of the artist (when dropping an artist), the name of the album (when an album), or when a track is dropped, a dialog is displayed, prompting for the name of the group (which is by default named 'Untitled').
---
> Drag a 'track', 'album' or 'artist' from library or library browser to the side pane. When the &playlist; is created, it will default to either the name of the artist (when dropping an artist), the name of the album (when an album), or when a track is dropped, a dialog is displayed, prompting for the name of the group (which is by default named 'Untitled').
484c444
< <para>To add songs, album or artist to an already existing group just drag and drop it from the library to the group's icon in the side pane.</para>
---
> <para>To add songs, album or artist to an already existing group just drag and drop it from the library to the &playlist;''s icon in the side pane.</para>
487c447
< <title>Dialog to create a new group</title>
---
> <title>Dialog to create a new &playlist;</title>
497c457
< <para>To delete songs from a group, simply select the song then choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Delete</guimenuitem></menuchoice><guimenu>Edit</guimenu> or simply press the <shortcut><keycombo><keycap>Delete</keycap></keycombo></shortcut> key.</para>
---
> <para>To delete songs from a &playlist;, simply select the song then choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Delete</guimenuitem></menuchoice><guimenu>Edit</guimenu> or simply press the <shortcut><keycombo><keycap>Delete</keycap></keycombo></shortcut> key.</para>
500,501c460,461
< <title>Modifying a Group</title>
< <para>Right click on group icon in Side Pane to display the <guimenu>group menu</guimenu>. This will allow the renaming and deletion of the group. Selecting the <guimenuitem>Rename</guimenuitem> will display a prompt for the new name of the group. Selecting the <guimenuitem>Delete</guimenuitem> will delete the group (note that the 'content' of the group is not removed from the library, just the 'playlist'.</para>
---
> <title>Modifying a &playlist;</title>
> <para>Right click on group icon in Side Pane to display the <guimenu>group menu</guimenu>. This will allow the renaming and deletion of the &playlist;. Selecting the <guimenuitem>Rename</guimenuitem> will display a prompt for the new name of the group. Selecting the <guimenuitem>Delete</guimenuitem> will delete the &playlist; (note that the 'content' of the &playlist; is not removed from the library, just the 'playlist'.</para>
506,508d465
<
< Not yet implemented
<
513c470
< <para>When a CD is inserted to the CD drive, it will appear in the side pane, and the songs on it can be displayed in &application;'s main window.</para>
---
> <para>When a CD is inserted to the CD drive, it will appear in the side pane, and the songs on it can be displayed in &application;''s main window.</para>
526d482
<
529,532d484
< <!--
<
< not yet implemented
<
537d488
< <para>Not sure about including this</para>
539c490,497
< <para>&nyi;</para>
---
>
> <figure id="fig-iradio">
> <title>Internet Radio in &application;</title>
> <screenshot>
> <graphic format="PNG" fileref="figures/rb-iradio.png"/>
> </screenshot>
> </figure>
>
540a499,510
>
> <sect3 id="iradio-adding">
> <title>Adding a station</title>
> <para>New stations can be added to the Internet Radio tuner, using the <menuchoice><guimenuitem>Add New Internet Radio Station</guimenuitem></menuchoice> menuoption.</para>
> <figure id="fig-add-station">
> <title>Adding a new station to &application;</title>
> <screenshot>
> <graphic format="PNG" fileref="figures/rb-iradio-add.png"/>
> </screenshot>
> </figure>
> </sect3>
>
543d512
< -->
549c518
< while the program is running. &application; adds it's icon to the notification area and this allows you to control &application; from your tray.</para>
---
> while the program is running. &application; adds it''s icon to the notification area and this allows you to control &application; from your tray.</para>
556c525
< Play / Pause — Play or Pause the currently selected song. This item changes depending on whether a song is playing or not.
---
> Play | Pause — Play or Pause the currently selected song. This item changes depending on whether a song is playing or not.
604,605c573,579
< <figure id="fig-preferences">
< <title>The Preferences Dialog</title>
---
> <sect3 id="prefs-view">
> <title>Columns</title>
> <para>This section of the dialog allows you to select
> which columns will be displayed.
> </para>
> <figure id="fig-general-preferences">
> <title>General Preferences</title>
609c583
< <imagedata fileref="figures/rb-prefs.png"
---
> <imagedata fileref="figures/rb-prefs-general.png"
613,614c587
< <phrase>Show the &application; preferences dialog.
< </phrase>
---
> <phrase>Show the general &application; preferences dialog.</phrase>
619,624d591
<
< <sect3 id="prefs-view">
< <title>Appearance</title>
< <para>This section of the dialog allows you to select
< how the toolbar will be displayed.
< </para>
627,628c594,595
< <sect3 id="prefs-columns">
< <title>Columns</title>
---
> <sect3 id="prefs-library">
> <title>Browser preferences</title>
630c597
< which columns are displayed in the song list.
---
> how the browser will be displayed.
632,647c599,600
< </sect3>
< </sect2>
<
< <sect2 id="toolbar-edit">
< <title>Toolbar editing</title>
<
< <para>The <guilabel>Toolbar editor</guilabel> lets you add,
< remove and re-order buttons on the &application; toolbar.
< </para>
<
< <para>You can select an item and move it by clicking on arrows,
< or simply dran'n'drop items.
< </para>
<
< <figure id="fig-toolbar-editor">
< <title>The Toolbar Editor</title>
---
> <figure id="fig-preferences">
> <title>Library Preferences</title>
649c602,611
< <graphic format="PNG" fileref="figures/rb-toolbar-editor.png"/>
---
> <mediaobject>
> <imageobject>
> <imagedata fileref="figures/rb-prefs-library.png"
> format="PNG"/>
> </imageobject>
> <textobject>
> <phrase>Show the library preferences dialog.
> </phrase>
> </textobject>
> </mediaobject>
651a614
> </sect3>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
