GNOME Bugzilla – Bug 654006
Missing topics from docs
Last modified: 2020-03-17 09:28:26 UTC
#: C/search.page:114(p) For more information on performing more complex search queries, see the <link xref=\"adv-search\"/> page. This link points to a non-existing page, perhaps it would be better to remove this sentence for now. The help/C/legal.xml file is rather just a stub, and it is not linked from the index page. Also, not a .page file either, so not translatable. The manage-coverart.page lacks content entirely, yet it is listed among the topics, should be removed until it gets some real content.
Thanks for the bug Gabor! I fixed the link in commit e463c927ab3d9008a5c60276c504c74f4d6f8c3d alongside a whole bunch of other broken links.
Created attachment 244346 [details] [review] Changed page ids and removed one link
Review of attachment 244346 [details] [review]: I would prefer to see keyboard-shortcuts left in as it does contain a list of keyboard shortcuts. While you update these pages, can you please update the page title capitalisation? They should all use "sentence capitalisation" (British English title capitalisation). ::: help/C/radio.page @@ +101,1 @@ <gui style="menuitem">Play Queue</gui></link>, you can right click on the Check if the link can be inside the <gui> element like "<gui style="menuitem" xref="play-queue">Play Queue</gui>".
(In reply to comment #0) > The help/C/legal.xml file is rather just a stub, and it is not linked from the > index page. Also, not a .page file either, so not translatable. legal.xml is complete enough at this moment. The lack of links is slightly problematic: ideally every author needs to be contacted and should give their explicit permission for their work to be licensed under that license.
Created attachment 244412 [details] [review] Uncommented index#advanced, added link inside <gui> element.
The patch is fine. Please improve the commit title: it should contain "bug 654006" in it and the page IDs were not broken, you *improved* them.
Pushed to master with commit ID b34054ad22b508a793f60572c8d60ab34e1d5add I changed the comma in introduction.page too. Thanks for the review, Kat. :)
Created attachment 244636 [details] [review] Modified manage-playlists, sort and import pages I have changed some content in these pages because of differences in the gui elements and need for some spell checking. It would be awesome if someone reviewed this and marked it okay to be pushed to master. :)
Review of attachment 244636 [details] [review]: manage-playlists.page is way too long, I recommend splitting it into one page per section. Either have an index#playlist section or a playlist landing page. Explain your reasoning for choosing the one that you do. ::: help/C/import.page @@ +31,3 @@ + appropriate source by <app>Banshee</app>, imported music is therefore + found in the <gui>Music</gui> library, imported videos in the + <gui>Videos</gui> library and so on.</p> Programs are not intelligent, be more precise and use simpler language: "Imported file are grouped by type. For example, music is imported into the <gui>Music</gui> library, while videos are imported into the <gui>Videos</gui> library" @@ +35,1 @@ + <p>To import music or video files from your computer, choose "select" is better than "choose" for menus. @@ +42,3 @@ <p>Plugins may add additional import choices. See <link xref="#plugins"/> below.</p> + </note>--> This should be below the <terms>. @@ +100,2 @@ <p>You can also import music from playlists. Most playlist files end in + <em>m3u</em>. To import from a playlist, from the <app>Banshee</app> menu "M3U" is the correct way to write the name. @@ +103,3 @@ + <gui style="menuitem">Import Playlist</gui></guiseq> + and locate the playlist file in your folder, select + it and press <gui style="button">Import</gui>.</p> Split this into two sentences. "Find", not "locate". ::: help/C/manage-playlists.page @@ +37,3 @@ <title>Normal playlists</title> + <p>A normal playlist is a list of media that you add and manage. You might Add to what? Reword. @@ +45,3 @@ + <title>To create a new playlist:</title> + <item> + <p>Press <keyseq><key>Ctrl</key> <key>N</key></keyseq> or select Remove the extra space. @@ +55,3 @@ + </item> + <item> + <p>To add songs to the newly created playlist, select the track(s) you "tracks" instead of "track(s)" @@ +57,3 @@ + <p>To add songs to the newly created playlist, select the track(s) you + would like to add to the playlist, right click them, and select + <guiseq><gui style="menuitem">Add to Playlist</gui></guiseq> and choose This is a one item <gui>, so should not be inside a <guiseq>. @@ +63,3 @@ + pane.</p> + <note style="tip"> + <p>To dynamically create a playlist with multiple tracks, select all I'm not sure what "creating dynamically" is, please simplify. @@ +65,3 @@ + <p>To dynamically create a playlist with multiple tracks, select all + the tracks you wish to add while holding <key>Ctrl</key> and drag them + over the name of your playlist source on the left hand pane. For What's a playlist source? @@ +70,3 @@ + option called <gui><em>New Playlist</em></gui> will appear under the + chosen source and you can drop the tracks over + <gui><em>New Playlist</em></gui> to add them to the playlist.</p> Is this <em>ed in the UI? If not, it shouldn't be in the help. @@ +77,3 @@ + <p>To give your playlist its own name, right click on the playlist of + your choice and select <gui style="menuitem">Rename</gui>. Now enter + the desired name for your playlist.</p> To name the playlist, right click on the playlist and […]. Enter the new name for the playlist." ::: help/C/sort.page @@ +39,3 @@ + according to the content under a particular column. By default, + <app>Banshee</app> displays columns for songs including <gui>Name</gui>, + <gui>Artist</gui>, <gui>Album</gui> and <gui>Time</gui>. To add additional "add additional"? :) "To add columns, right click on…"
Created attachment 244785 [details] [review] Updated playlists-import-sort pages Kat, The <gui><em>New Playlist</em></gui> is <em>-ed in the UI. All other points have been duly taken and changes made. Thank you for reviewing my extra long patch. :)
Review of attachment 244785 [details] [review]: It would be more appropriate to split manage-playlists.page in a commit of its own and then to make your changes in another commit. This way, it will be easier to trace what you are doing through the history. Please try to keep the page naming at least somewhat hierarchical: for example, name pages about playlists "playlist-*something*.page". You also need to check if banshee has a playlist dialog with a help button: if it does, you need to check that the link still works. ::: help/C/import.page @@ +31,3 @@ + imported music is + found in the <gui>Music</gui> library, imported videos in the + <gui>Videos</gui> library and so on.</p> Reflow. @@ +43,2 @@ <p>Choose this option to import all music and video files within + a specified folder, including all sub-directories. You will be prompted Calling a directory a "folder" and then referring to "sub-directories" is a bit confusing as both are types or "directory" or "folder": stick to either "folder" or "directory". I personally prefer "directory", but "folder" is more user friendly. "within the specified folder" or "within a specific folder". Think of the first as "the folder that you chose" and the latter as "whichever folder you happen to chose". "prompted" is not a nice word, reword. Use consistent wording for this throughout the page. @@ +49,1 @@ <p>Choose this option to import only the specific file or files See above about specific files (I now this isn't yours, but fix it anyway :) ). @@ +53,3 @@ <item> + <title><gui>Amazon MP3 Purchase</gui></title> + <p>Choose this option to import your amazon purchases, which are files Amazon is a proper name in this case. @@ +54,3 @@ + <title><gui>Amazon MP3 Purchase</gui></title> + <p>Choose this option to import your amazon purchases, which are files + that end with <file>amz</file>. When a <file>.amz</file> file is selected, "…end with a <file>.amz</file> extension." @@ +56,3 @@ + that end with <file>amz</file>. When a <file>.amz</file> file is selected, + <app>Banshee</app> will open the file and connect to the Amazon MP3 store + to begin its download. Please look at "the", not "its" @@ +57,3 @@ + <app>Banshee</app> will open the file and connect to the Amazon MP3 store + to begin its download. Please look at + <link xref="amazon#amazon-manual">manually importing</link> "manual importing" @@ +62,3 @@ + <item> + <title><gui>iTunes Media Player</gui></title> + <p>Choose this option to import your iTunes. Click the iTunes what? @@ +67,3 @@ + computer. After you select the file, you can additionally check the + <gui style="checkbox">Import song ratings</gui>, + <gui style="checkbox">Import play statistics(playcount,etc)</gui> and Missing space @@ +74,3 @@ + <title><gui>Rhythmbox Music Player</gui></title> + <p>Choose this option to import tracks from your + <app>Rhythmbox Music Player.</app></p> Full stop needs to be outside <app> tags @@ +79,3 @@ + <title><gui>eMusic Tracks</gui></title> + <p>Choose this option to import your eMusic purchases, which are files + that end with <file>.emx</file>. When a <em>.emx</em> file is selected, See above for file extension. <file>, not <em> @@ +100,2 @@ <p>You can also import music from playlists. Most playlist files end in + <file>.m3u</file>.</p> M3U playlist files end in .m3u; other types of playlist files end in other file extensions :) which is not to say that M3U playlists are not the most common, but this needs to be worded differently to convey that information. @@ +101,3 @@ + <file>.m3u</file>.</p> + <steps> + <title>To import from a playlist:</title> To import what from a playlist? @@ +104,3 @@ + <item> + <p>Select <guiseq><gui style="menu">Media</gui> + <gui style="menuitem">Import Playlist</gui></guiseq>.</p> Indentation @@ +108,3 @@ + <item> + <p>Find the playlist file on your computer, select + it and press <gui style="button">Import</gui>.</p> Indentation ::: help/C/playlists.page @@ +10,3 @@ + + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + Where's Paul? :) @@ +16,3 @@ + </credit> + + <desc>Regular and smart playlists.</desc> Maybe use links to subpages here. ::: help/C/sort.page @@ +40,3 @@ + <app>Banshee</app> displays columns for songs including <gui>Name</gui>, + <gui>Artist</gui>, <gui>Album</gui> and <gui>Time</gui>. To add + columns, using your mouse right click on any of the columns and Don't mention mouse because touchscreens don't have mice. @@ +41,3 @@ + <gui>Artist</gui>, <gui>Album</gui> and <gui>Time</gui>. To add + columns, using your mouse right click on any of the columns and + <app>Banshee</app> will display all available column to choose from. Click "to choose from" is redundant as it's implied by the subject. "Columns", not "column" :)
Created attachment 245166 [details] [review] Delete manage-playlosts.page Splitting commits. Commit 1 - Delete manage-playlists.page
Created attachment 245167 [details] [review] Migrate manage-playlists->3 playlists pages Migrate manage-playlists.page -> playlists.page, playlists-regular.page,playlists-smart.page
Created attachment 245168 [details] [review] Migrate manage-playlists-3 playlist pages Migrate manage-playlists.page -> playlists.page, playlists-regular.page, playlists-smart.page Sorry, I hadn't validated the previous patch. This one's good.
Created attachment 245170 [details] [review] Fixed broken links Fixed broken links because of migration
Created attachment 245171 [details] [review] Updated sort and import pages Made changes to other pages according to the review.
Created attachment 245174 [details] [review] Deleted manage-playlists.page Forgot to edit the Makefile, so re-attaching updated patch. Order in which patches should be applied is: 1)Delete manage-playlists.page 2)Migrate manage-playlists.page->3playlist pages 3)Fixed broken links 4)Updated sort and import pages
Aruna, can you resubmit that as one patch?
Created attachment 271428 [details] [review] Merge all patches to one.
Banshee is not under active development anymore and had its last code changes more than three years ago. Its codebase has been archived. Closing this report as WONTFIX as part of Bugzilla Housekeeping to reflect reality. Please feel free to reopen this ticket (or rather transfer the project to GNOME Gitlab, as GNOME Bugzilla is being shut down) if anyone takes the responsibility for active development again. See https://gitlab.gnome.org/Infrastructure/Infrastructure/issues/264 for more info.