After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 725322 - add help page to create playlist using albums
add help page to create playlist using albums
Status: RESOLVED FIXED
Product: gnome-music
Classification: Applications
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
gnome-music-maint
Depends on:
Blocks:
 
 
Reported: 2014-02-27 14:20 UTC by Shobha
Modified: 2014-03-18 07:18 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
help page for creating playlist via albums (2.01 KB, patch)
2014-02-27 14:20 UTC, Shobha
none Details | Review
help page for creating playlist via albums (2.38 KB, patch)
2014-02-28 03:29 UTC, Shobha
none Details | Review
help page for creating playlist via albums (2.39 KB, patch)
2014-02-28 10:18 UTC, Shobha
none Details | Review
help page for creating playlist via albums (2.82 KB, patch)
2014-03-03 17:15 UTC, Shobha
none Details | Review
help page for creating playlist via albums (3.03 KB, patch)
2014-03-03 18:51 UTC, Shobha
needs-work Details | Review
help page for creating playlist via albums (3.37 KB, patch)
2014-03-04 17:14 UTC, Shobha
needs-work Details | Review
help page to create playlist using albums (3.15 KB, patch)
2014-03-07 22:28 UTC, Shobha
needs-work Details | Review
help page for creating playlist using albums (3.27 KB, patch)
2014-03-08 16:30 UTC, Shobha
committed Details | Review

Description Shobha 2014-02-27 14:20:21 UTC
Created attachment 270479 [details] [review]
help page for creating playlist via albums

added a help page for creating playlist using albums.
please review.
Thanks!
Comment 1 Vadim Rutkovsky 2014-02-27 14:26:31 UTC
Pushed as https://git.gnome.org/browse/gnome-music/commit/?id=cd0cd4f, thanks
Comment 2 Kat 2014-02-27 14:31:59 UTC
(In reply to comment #1)
> Pushed as https://git.gnome.org/browse/gnome-music/commit/?id=cd0cd4f, thanks

Hi Vadim, could you wait on a review from the docs team before pushing? there are a few language issues in that patch which need to be fixed.
Comment 3 Vadim Rutkovsky 2014-02-27 14:46:00 UTC
(In reply to comment #2)
> (In reply to comment #1)
> > Pushed as https://git.gnome.org/browse/gnome-music/commit/?id=cd0cd4f, thanks
> 
> Hi Vadim, could you wait on a review from the docs team before pushing? there
> are a few language issues in that patch which need to be fixed.

Oops, sorry, reverted the commit.

We're making a new 'user docs' component, which email should I use to make sure documentation team will get a notification for that?
Comment 4 Kat 2014-02-27 14:59:10 UTC
(In reply to comment #3) 
> Oops, sorry, reverted the commit.

Thanks :)

> We're making a new 'user docs' component, which email should I use to make sure
> documentation team will get a notification for that?

gnome-user-docs-maint@gnome.bugs please
Comment 5 Shobha 2014-02-28 03:29:16 UTC
Created attachment 270534 [details] [review]
help page for creating playlist via albums 

hi! kittykat,

now the patch is having an updated Makefile.am too. :)
and checked with jhbuild too. build sucessfully.

Thanks!
Comment 6 Shobha 2014-02-28 10:18:54 UTC
Created attachment 270548 [details] [review]
help page for creating playlist via albums

corrected "id" the page tag's attribute from "create-playlist" to "create-playlist-via-albums".

Thanks!
Comment 7 Shobha 2014-03-03 17:15:02 UTC
Created attachment 270821 [details] [review]
help page for creating playlist via albums

updated patch
Comment 8 Shobha 2014-03-03 18:51:22 UTC
Created attachment 270836 [details] [review]
help page for creating playlist via albums
Comment 9 André Klapper 2014-03-03 19:25:35 UTC
Comment on attachment 270836 [details] [review]
help page for creating playlist via albums

>+    <desc>Create playlist and add songs to it through albums.</desc>
>+  <title>Create playlist by albums</title>

"Create playlist" - noun needs some article. What does the "through" mean? Do I need to put songs through albums first in order to create playlists?

>+  <p>You can view all your albums by clicking on <gui>Albums</gui> button.</p>

If there's only one button in the interface, then the noun needs a definite article.
Also, you should use <gui style="button">.

>+    <title>To add all the song in the album:</title>

Typo: all the song

>+      <p>Click on the <em>check</em> button on the right side of the
>+      toolbar.</p>

I have not tried the UI, but is "check" really not capitalized? Why do you use <em> instead of  <gui style="button"> if it's a button?

>+      <gui>Select Playlist</gui> dailog will appear.</p>

The noun needs a definite article, plus typo in "dailog"

>+      <p>Click on <gui>Select</gui> button.</p>

Either you need a definite article here, or you could drop "button". In any case, <gui> should be <gui style="button">.

>+      <p>Click on the <em>check</em> button.</p>

Same as above.

>+      <p>Click on the <gui>Add to Playlist</gui> button.

Should be <gui style="button">. You're using a "the" here, I like that. :)

>+      <gui>Select Playlist</gui> dailog will appear.</p>

Same as above.

>+      <p>Click on <gui>Select</gui> button.</p>

Should be <gui style="button"> and missing a definite article ("the") here.

>+    <p>To select all albums click
>+    <guiseq><gui>Click on items to select them
>+    </gui><gui>Select All</gui></guiseq> on the toolbar or press
>+    <keyseq><key>Ctrl</key><key>A</key></keyseq>.</p>

Is "Click on items to select them" really a GUI item? If I read this aloud, you click click on items and then you select them select all on the toolbar.
Comment 10 Shobha 2014-03-04 17:14:57 UTC
Created attachment 270922 [details] [review]
help page for creating playlist via albums

corrected please review :)
let me know the further corrections if any.
thanks!
Comment 11 Kat 2014-03-06 20:09:14 UTC
Review of attachment 270922 [details] [review]:

::: help/C/create-playlist-via-albums.page
@@ +22,3 @@
+  <p>You can view all your albums by clicking on the
+  <gui style="button">Albums</gui> button.</p>
+  <steps>

Leave a blank line above here and also after the title.

@@ +25,3 @@
+    <title>To add all the songs in an album:</title>
+    <item>
+      <p>Click on the <em>check</em> button on the right side of the

I wouldn't use <em> and I'd say "button in the top-right of the screen"

@@ +30,3 @@
+    <item>
+      <p>Click on the <gui style="button">Add to Playlist</gui> button. The
+      <gui>Select Playlist</gui> dialog will appear.</p>

I don't think you need to say here that a dialog will appear.

@@ +40,3 @@
+    </item>
+  </steps>
+  <steps>

Blank line between the lists please.

@@ +43,3 @@
+    <title>To add selected songs from an album:</title>
+    <item>
+      <p>Click on the album of your choice.</p>

"Click on an album.". As you're not choosing it for the reader, then it's clearly their choice.

@@ +77,3 @@
+      </item>
+    </list>
+  </note>

I recommend that you make these into two normal paragraphs instead of a list inside a note.

::: help/Makefile.am
@@ +5,2 @@
 HELP_FILES = \
+        create-playlist-via-albums.page \

Drop the "via" from the page title.
Comment 12 Shobha 2014-03-07 22:28:43 UTC
Created attachment 271277 [details] [review]
help page to create playlist using albums

please review
Thanks!
Comment 13 Kat 2014-03-07 22:41:13 UTC
Review of attachment 271277 [details] [review]:

Almost there :)

::: help/C/playlist-create-albums.page
@@ +23,3 @@
+  <p>You can view all your albums by clicking on the
+  <gui style="button">Albums</gui> button.</p>
+  <steps>

Leave blank line between paragraph and steps.

@@ +29,3 @@
+      toolbar.</p>
+    </item>
+    <item>

You need to select the albums that you want to add, before adding them, right?

@@ +41,3 @@
+  </steps>
+
+  <steps>

It would be nice if you could add a paragraph between the two steps lists, something along the lines of "you can also create a playlist from specific songs"

@@ +66,3 @@
+  <note>
+    <p>To select all the songs click
+    <guiseq><gui>Click on items to select them </gui><gui>Select All</gui></guiseq>

Extra space before </gui>, please remove it.

@@ +69,3 @@
+    in the toolbar or press <keyseq><key>Ctrl</key><key>A</key></keyseq>.</p>
+
+    <p>To clear selections click

To clear "the selection" as there's only one selection at any given time (which can contain multiple items in it).
Comment 14 Shobha 2014-03-08 16:30:22 UTC
Created attachment 271320 [details] [review]
help page for creating playlist using albums

corrections done. please review :)
Thanks!
Comment 15 Kat 2014-03-08 22:43:28 UTC
Review of attachment 271320 [details] [review]:

Please check your reflowing before you push.
Comment 16 Shobha 2014-03-12 09:28:00 UTC
patch pushed to master in the commit:f6d4e28916a86715b6736455bad5022a8204eb69
Comment 17 Shobha 2014-03-12 09:38:34 UTC
patch for Makefile.am is updated in the commit:
52ab6b1734145e58202b40e6acdd99b354b82e2a
Comment 18 Shobha 2014-03-18 07:18:48 UTC
please ignore the commit for Makefile.am above. 

patch for Makefile.am is updated in the commit: d45907853f362e168b23282411e2a21085e57631