Bug 320347 - Update Handbook with new features for 2.8
Summary: Update Handbook with new features for 2.8
Status: RESOLVED FIXED
Alias: None
Product: amarok
Classification: Applications
Component: Documentation (show other bugs)
Version: 2.7-git
Platform: Other Linux
: NOR task
Target Milestone: 2.8
Assignee: Amarok Developers
URL: https://projects.kde.org/projects/ext...
Keywords: junior-jobs, release_blocker
Depends on:
Blocks:
 
Reported: 2013-05-27 11:49 UTC by Myriam Schweingruber
Modified: 2013-08-13 17:56 UTC (History)
4 users (show)

See Also:
Latest Commit:
Version Fixed In: 2.8


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Myriam Schweingruber 2013-05-27 11:49:37 UTC
Several new features have found their way into the upcoming Amarok 2.8, the handbook needs to be updated accordingly.
For new features and changes, see the ChangLog in the source.
Comment 1 Myriam Schweingruber 2013-06-25 10:06:15 UTC
The handbook can be found here:

http://userbase.kde.org/Amarok/Manual

Features that need to be documented are:

* Volume fade-out is now also available for pause.
   * The Files browser now has a Refresh button. (BR 213666)
   * The active playlist item is animated with a soft glow effect.
   * Added an audio analyzer visualization applet.
   * Added a function for resetting the GUI layout back to default state. (BR 300753)
   * Pressing enter when searching collections now adds found tracks to the playlist and
     clears the search bar, this is a very convenient way to populate your playlist.
   * Allow to transcode only certain (different format, playability) tracks when
     transferring them to a collection; patch by Anmol Ahuja. (BR 312407)
   * On-Screen-Display fades in/out smoothly.
   * Added support for .asx playlists; patch by Tatjana Gornak. (BR 170207)
   * Add Radio GFM radio streams to Cool Stream Script. (BR 317978)
   * Added options to pause playback on system suspend and to inhibit automatic suspend
     if playing a track (enabled by default); patch by Anmol Ahuja. (BR 259862, 222571)
   * Playlist files are now read asynchronously when possible; patch and great deal of
     refactoring by Tatjana Gornak. (BR 291934)
   * Added support to filter tracks to scrobble to Last.fm by label. Patch by Vedant
     Agarwala. (BR 140198)
   * Added transcoding support for Opus codec if ffmpeg is compiled with support for the
     libopus library, patch by Martin Brodbeck.
   * Added keyboard shortcuts for small 2 s seeks (Ctrl + Left/Right) and long 1 minute
     seeks (Shift + Left/Right) in addition to standard 10 s seeks. Durations are now
     configurable in amarokrc, see Amarok Handbook. Patch by Anmol Ahuja. (BR 177258)
   * Added support for files in Opus codec if Amarok is compiled against recent enough
     TagLib (post 1.8), patch by Martin Brodbeck. (BR 312905)
   * Added Ctrl+H shortcut to randomize playlist, patch by Harsh Gupta. (BR 208061)
Comment 2 Myriam Schweingruber 2013-06-25 10:06:55 UTC
The following changes need to be checked and updated in the handbook as well:

 CHANGES:
   * Removed the splash screen.
   * Playlist-related actions were harmonized, double-clicking, pressing enter or using
     any "play media" action will prepend tracks to queue and immediately start playing;
     middle-clicking appends to playlist; append or replace actions will no longer start
     playback. (BR 145468, BR 145490, BR 194549)
   * When a new collection plugin is enabled, its collections appear immediately without a
     need for restart.
   * Update the MusicBrainz tagger to MusicBrainz web service 2, make it show some more
     good suggestions for tagging, and add some options to help choosing the best results.
   * Add note about generating .mood files into Moodbar Options; patch by Harsh Gupta with
     tweaks by Matěj Laitl. (BR 289483)
   * Amarok now depends on Qt 4.8.2.
   * Add prepareToQuit() signal to Amarok.Window script bindings; patch by Anmol Ahuja.
     (BR 241066)
   * Data CDs are now recognized in Amarok; patch by Anmol Ahuja. (BR 316128)
   * On-Screen-Display now uses the system font instead of hardcoded sans-serif.
     (BR 248707)
   * Fancy behavior of some context menus showing different actions when Shift key is held
     has been reverted. All entries are now shown all the time.
   * The dynamic playlist behavior has changed. It will no longer generate "pretty good"
     playlists that do not fulfill the given biases. Instead it might add no song at all
     if given impossible-to-fulfill conditions.
   * The "tracks have been hidden in the playlist" warning when filtering the playlist is
     now displayed inside the playlist. (BR 260352)
   * Update tag widget for Layout edit, filter edit, organize collection and guess tag
     dialog.
   * When fadeout and/or Replay Gain isn't possible, gray-out related UI elements in order
     not to fool users.
Comment 3 Nick Adams 2013-06-30 21:40:28 UTC
This is the first time I've done documentation for KDE, and I am more than willing to this, but I want to make sure I'll be doing the right thing first! I've already edited the Keyboard shortcuts page (http://userbase.kde.org/Amarok/Manual/References/KeybindingReference/AmarokShortcuts). Should I be moving all of the pages in the handbook to the Amarok2.8 (as I did that one) and changes references of 2.7 to 2.8 as I update info? I'll gladly begin to move the handbook over to 2.8, but if that is someone's oversight, I can continue to just make small content updates.
Comment 4 Myriam Schweingruber 2013-06-30 22:49:12 UTC
(In reply to comment #3)
> This is the first time I've done documentation for KDE, and I am more than
> willing to this, but I want to make sure I'll be doing the right thing
> first! I've already edited the Keyboard shortcuts page
> (http://userbase.kde.org/Amarok/Manual/References/KeybindingReference/
> AmarokShortcuts). Should I be moving all of the pages in the handbook to the
> Amarok2.8 (as I did that one) and changes references of 2.7 to 2.8 as I
> update info? I'll gladly begin to move the handbook over to 2.8, but if that
> is someone's oversight, I can continue to just make small content updates.

In essence this is basically the task, yes. Last time I did this I went through every page, checked if all screenshots were accurate and for the current version and checked the text as well, then changed the Category from 2.6 to 2.7. 
It is a bit tiresome and since there have been quite some changes since 2.7 it is usually a good idea to check with a current git version if everything is described correctly. Normally the ChangeLog should be up-to.date, of course the reference is the one in current git.
Comment 5 Nick Adams 2013-07-01 17:13:23 UTC
I've finished adding relevant features from the git 2.8-Beta 1 ChangeLog and did a lot of screenshot and text updating in the Handbook and the Quick Start Guide. Also all of the pages are now in the new Amarok2.8 category, expect for the topmost page (http://userbase.kde.org/Amarok), which I figured should be changed after 2.8 is the official stable release. All that needs to be changed is the category and a line of text at the top displaying the current stable version. 

Hopefully I didn't miss anything!
Comment 6 Myriam Schweingruber 2013-07-02 09:20:01 UTC
Wow, thank you for the awesome work.
Just a nitpick: some screenshots captions read 2.7, like the one in http://userbase.kde.org/Amarok/Manual/Introduction for example. Could you maybe check those as well?
Also there are apparently still some old screenshots around which I missed myself last time, like http://userbase.kde.org/File:Amarok2.4.1ConfigureDialogCollection.png. Also the screenshot of the systemtray seems quite wrong: http://userbase.kde.org/File:Amaroksystray.png

Since I am on a mobile connection this week I am a bit at loss to change those myself, could you maybe check all screenshots for accuracy and have the captions right as well? Adding the version in the image name is a good idea as it helps finding old stuff :)
Comment 7 Myriam Schweingruber 2013-07-15 08:38:00 UTC
BTW, old screenshots are quite easy to spot for full windows: if there is no Spectrum Analyzer, then it is outdated.
Comment 8 Valorie Zimmerman 2013-07-18 16:26:40 UTC
When checked, this screenie has been updated to 2.8:  http://userbase.kde.org/File:Amarok2.4.1ConfigureDialogCollection.png , however it is showing similar behavior to the problem I'm having with AmarokNew2.4.png - I replaced it, but the system renames it to 2.4, and displays improperly the old screenshot although the system shows the right current shot.

Valorie
Comment 9 Myriam Schweingruber 2013-07-18 17:14:54 UTC
(In reply to comment #8)
> When checked, this screenie has been updated to 2.8: 
> http://userbase.kde.org/File:Amarok2.4.1ConfigureDialogCollection.png ,
> however it is showing similar behavior to the problem I'm having with
> AmarokNew2.4.png - I replaced it, but the system renames it to 2.4, and
> displays improperly the old screenshot although the system shows the right
> current shot.

Where is this screenshot sued? Please give a link to the page.

FWIW: I have gone through several pages starting from the quickStart guide, and updated already several screenshots

Again, it is not just the screenshots, it is the text as well that needs to be check in accordance with current git.

Everybody: please do thorough checks, not just update the category. Please only update the category when you are 100% sure everything, really everything is accurate. Updating captions only is NOT a good idea
Comment 10 Myriam Schweingruber 2013-07-19 12:54:00 UTC
This page needs an update as well, it needs a CD and a media device connected for the screenshot: 

http://userbase.kde.org/Amarok/QuickStartGuide/TheMusicCollection

Also, if you really wnat to have the new files you upload to show, you need to rename them, don't update screenshots for 2.8 with filenames that don't say it is about 2.8, and you of course need to update the link in the actual wiki page

Re about http://userbase.kde.org/File:Amarok2.4.1ConfigureDialogCollection.png:

Do not update that file with 2.8 screenshots when the file name explicitly says 2.4.1, that makes no sense at all

Also, the screenshots do not show the complete window, please do not make screenshots of partial views of a configuration dialog, do at least expand it so it shows all the content.

FWIW: there already is a newer view of this, please check what I updated, the new file is http://userbase.kde.org/File:Amarok_2.8_ConfigurationDialogLocalCollection.png
Comment 11 Myriam Schweingruber 2013-07-19 15:48:18 UTC
(In reply to comment #10)
> This page needs an update as well, it needs a CD and a media device
> connected for the screenshot: 
> 
> http://userbase.kde.org/Amarok/QuickStartGuide/TheMusicCollection

Done
Comment 12 Myriam Schweingruber 2013-07-19 22:41:28 UTC
Status update:
All pages check up unto http://userbase.kde.org/Amarok/Manual/Organization/Collection/WorkingWithMediaDevices, except for http://userbase.kde.org/Amarok/Manual/Organization/Collection/RemoteCollections/Samba

The latter needs to have the screenshots checked with KDE 4.10.x or later, not sure this is still accurate. I have an active cifs share, and don't want to disable it just for that, so if somebody without such a setup could check I would very much appreciate that.
Comment 13 Myriam Schweingruber 2013-07-25 11:50:11 UTC
(In reply to comment #12)
> Status update:
> All pages check up unto
> http://userbase.kde.org/Amarok/Manual/Organization/Collection/
> WorkingWithMediaDevices, except for
> http://userbase.kde.org/Amarok/Manual/Organization/Collection/
> RemoteCollections/Samba
> 
> The latter needs to have the screenshots checked with KDE 4.10.x or later,
> not sure this is still accurate. I have an active cifs share, and don't want
> to disable it just for that, so if somebody without such a setup could check
> I would very much appreciate that.

Samba and UPnP is done, thanks to Konrad.
Comment 14 Myriam Schweingruber 2013-07-26 13:44:36 UTC
Status update: currently editing http://userbase.kde.org/Amarok/Manual/Playlist/SavedPlaylists

Only 24 pages to go out of 60 ...
Comment 15 Myriam Schweingruber 2013-08-13 17:56:31 UTC
Done, and the mainpage http://userbase.kde.org/Amarok is updated as well