diff --git a/doc/Screenshot_20170212_165351.png b/doc/Screenshot_20170212_165351.png new file mode 100644 index 00000000..d1591749 Binary files /dev/null and b/doc/Screenshot_20170212_165351.png differ diff --git a/doc/index.docbook b/doc/index.docbook index 927fbadb..6885288d 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,416 +1,237 @@ Elisa"> Elisa"> ]> The &elisa; Handbook Matthieu -Ugnacious +Gallien matthieu_gallien@yahoo.fr 2017 Matthieu Gallien &FDLNotice; 2017-02-11 - Elisa 0.1 - - &elisa; is a music player designed to be simple to use. KDE kdemultimedia Elisa audio music Introduction &elisa; is a music player designed to be simple to use. +It gets your music from different sources like local directories, Baloo indexer, ... + + +&elisa; allows you to browse your music, build a playlist and plays it. Using &elisa; - - - - -Here's a screenshot of &elisa; +Here's a screenshot of &elisa; start screen - + Screenshot -More &elisa; features +&elisa; features -It slices! It dices! and it comes with a free toaster! -The Squiggle Tool - - - - - Squiggle - - is used to draw squiggly lines all over -the &elisa; main window. It's not a bug, it's a feature! +&elisa; provides two different tasks: browsing your music to build a playlist and playing music. - - - - -Command Reference - - Enables search for menu items - -For Applications with default menu items and some special items where user -needs additional information use something like: -"Apart from the common KDE menu items you find these action in the menu: - -File -> Special Action: Explanation of special action - -Tools -> Special Tool: Explanation of special tool - -Use variablelist markup for this ---> - - -The main &elisa; window - -The File Menu +Browsing Music - - - - - -&Ctrl;N - -File -New - -Creates a new document - - - - - -&Ctrl;S - -File -Save - -Saves the document - - - - - -&Ctrl;Q - -File -Quit - -Quits &elisa; - - +From the different sources of music, it collects all your music and analyses their metadata such that their title, artist, ... +It provides two way to browse your music: a list of all albums or a list of all artists. - - - - - - -The Settings and Help Menu -&elisa; has the common &kde; Settings and Help -menu items, for more information read the sections about the Settings Menu and Help Menu -of the &kde; Fundamentals. +Each method uses an updated view of all your music along with a filter to allow to quickly find what you are looking for. - - - -The Help Menu -&elisa; has the common &kde; Help menu item, for more information read the section -about the Help Menu of the &kde; Fundamentals. +The filter of the view of all albums is implemented on the title or the artist of albums or the list of artists of each track of an album. +The filter of the view of all artists is implemented on the name of the artists. - -Menu Items -Apart from the common &kde; menus described in the Menu -chapter of the &kde; Fundamentals documentation &elisa; has these application specific menu entries: + +Building a Playlist + +When browsing your music, artists, albums and tracks can be added with a button shown when mouse is over it. +It is also possible to clear the playlist and at the same time add some music. + + +A toolbar below the playlist allow to operate on it. Currently it is only possible to clear it. - - - - -The Help Menu -&elisa; has a default &kde; Help menu as described in the -&kde; Fundamentals -with two additional entries: - - - - - -Developer's Guide to &elisa; - - - + +Playing Music -Programming &elisa; plugins is a joy to behold. +The playlist is read in the order of the tracks unless the Shuffle option is selected. +At the end of the list playing is stopped unles the Repeat option is selected. + +It is possible to switch to the next or previous track in the list. If the mouse is over a track, it is possible to skip to it by pressing a button. + + +The currently playing track is indicated by a flashing play icon. + + + - -Questions and Answers - - - - - - -My Mouse doesn't work. How do I quit &elisa;? - - -You silly goose! Check out the Commands -Section for the answer. - - - - -Why can I not twiddle my documents? - - -You can only twiddle your documents if you have the foobar.lib -installed. - - - - - Credits and License &elisa; -Program copyright 2010-2014 John Q. Hacker jqh@kde.org +Program copyright 2015-2017 Matthieu Gallien matthieu_gallien@yahoo.fr Contributors: -Konqui the &kde; Dragon konqui@kde.org - -Tux the &Linux; Penguin tux@linux.org +Luigi Toscano (help for translations)luigi.toscano@tiscali.it -Documentation Copyright © 2012-2014 George N. Ugnacious gnu@kde.org +Documentation Copyright © 2017 Matthieu Gallien matthieu_gallien@yahoo.fr &underFDL; -&underGPL; -&underBSDLicense; -&underArtisticLicense; -&underX11License; +&underLGPL; - - Installation How to obtain &elisa; - - &install.intro.documentation; Requirements - - - -In order to successfully use &elisa;, you need few libraries from -&kf5; 5.1 (bar, baz). Foobar.lib is -required in order to support the advanced &elisa; features. &elisa; uses -about 5 megs of memory to run, but this may vary depending on your -platform and configuration. - - -All required libraries as well as &elisa; itself can be found -on The &elisa; home page. +There are no special requirements for use of &elisa;. Currently the only supported +indexer is Baloo but support for Tracker and the indexer generally available on +Windows are planned. It is also possible to have &elisa; index your music by itself. - You can find a list of changes at http://apps.kde.org/kapp. +url="https://phabricator.kde.org/project/profile/193/">Elisa Project. Compilation and Installation &install.compile.documentation; Configuration -Don't forget to tell your system to start the dtd -dicer-toaster daemon first, or &elisa; won't work! + +Currently no configuration is required before use of &elisa;. + &documentation.index;