WIP Manual 2.1.x updates #59

esbrandt · 2017-06-24T11:00:43Z

This PR aims to document the following user visible changes, merged to https://github.com/mixxxdj/mixxx/master since the latest stable release.

This is my filter on https://github.com/mixxxdj/mixxx/pulls

is:pr is:closed merged:>=2015-12-29 sort:updated-asc

TODO

Note:
I will not cover effects in this PR (~~crossed out bullet points~~), since #64 is already in progress

…ting

…aphviz related bug was fixed in http://www.sphinx-doc.org/en/stable/changes.html#release-1-3-2-released-nov-29-2015. Just install the latest version.

… for Windows. List recommended ways of installing the client.

This reverts commit 1d99f83.

…ewer , see"" This reverts commit 8564b02.

…es. Add non-duplicate info to the text where applicable.

…j/mixxx#527

…ous version. For even older versions, users can follow the link to the Launchpad.net page.

…, see mixxxdj/mixxx#849

mixxxdj/mixxx#1263

… respectively ) to macOS. Bulk rename all occurrences across the manual, and go with the current name.

…ucts into Mixxx´ playlists OR crates. Also update list of supported playlist formats, and use ``third-party`` instead of ``3rd party`` (translator trap)

…to have it current

``--debugAssertBreak`` ``--logLevel`` ``--controllerDebug`` mixxxdj/mixxx#1265 mixxxdj/mixxx/mixxxdj#118 mixxxdj/mixxx#1004

…-men mixxxdj/mixxx#1106

…ixxxdj/mixxx#1203

…m the one on the waveform summary

…ates root element. See mixxxdj/mixxx#945. Emphasize, that importing from existing playlists/crates will result in bulk-adding the content to the single selected playlist/crate.

…nces accordingly

…ences accordingly

…xdj/mixxx#617

…in a table. Use :file: role to highlight file suffixes in text.

…eform to the format ``#:label``. See mixxxdj/mixxx#992

…mixxx#728

rryan

Awesome work! Thanks a bunch. I skimmed for language / spelling and things looked good. Just some tiny nits. I think we should merge ASAP even if you aren't done yet, so that we can include these changes in the PDF that we bundle in the actual release build.

rryan · 2018-04-15T00:28:41Z

source/chapters/djing_with_mixxx.rst

@@ -369,8 +366,17 @@ choose to create them in the preferences.
 Record your mix to disk
 -----------------------

-.. versionadded:: 2.0
-   Displays the duration of the recording.
+.. versionadded:: 2.10


2.1.0 ? We aren't to 2.10 ... yet! :)

IMO these "version added" notices clutter the manual. They're good for release announcements, but I don't know why someone reading the manual would care when a feature was added.

rryan · 2018-04-15T00:30:13Z

source/chapters/getting_involved.rst

-  <https://lists.sourceforge.net/lists/listinfo/mixxx-devel>`_
-* Join our :term:`IRC` channel, #mixxx on `Freenode <http://www.freenode.net/>`_
+  <https://sourceforge.net/projects/mixxx/lists/mixxx-devel>`_
+* Join our :term:`IRC` channel, #mixxx on `Freenode <https://freenode.net/>`_


Replace IRC with Zulip?

rryan · 2018-04-15T00:33:42Z

source/chapters/library.rst

@@ -409,6 +420,10 @@ Edit metadata of audio files
 .. sectionauthor::
   S.Brandt <[email protected]>

+.. versionadded:: 2.10


rryan · 2018-04-15T00:34:08Z

source/chapters/library.rst

@@ -531,12 +550,19 @@ mixing or for using Mixxx as media player.

 The Auto DJ features in detail:

+.. versionadded:: 2.10


rryan · 2018-04-15T00:36:10Z

source/chapters/library.rst


-Browse - Loading remote tracks
-==============================
+Computer - Loading remote tracks


"remote" is an odd word here. What about "Loading tracks from anywhere on your computer" ?

rryan · 2018-04-15T00:39:03Z

source/chapters/user_interface.rst

 **Track Title**
  The title of the track that was loaded into a deck is displayed on top. This
  is the same as the title listed under the :guilabel:`Title` column heading in
  the Mixxx library. This information is initially loaded from the track's
-  :term:`metadata`.
+  :term:`metadata`. Is the metadata missing, parse the title and the artist


"If the metadata is missing, the title and artist are guessed from the filename."

rryan · 2018-04-15T00:40:19Z

source/chapters/user_interface.rst

@@ -135,8 +138,9 @@ separate waveforms. Select your preferred appearance in
   Mixxx alternative skin (Deere) - Separate waveforms

 .. warning :: If you have a slower computer and notice performance issues with
-              Mixxx, try to lower the frame rate or change the waveform type in
-              :menuselection:`Preferences --> Waveforms`.
+              Mixxx, try to lower the frame rate or change the type for waveform


Flows a little better?

"try lowering the frame rate or changing the waveform type in :menuselection:`Preferences --> Interface --> Waveforms"

…ses review comments

Be-ing · 2018-04-15T06:20:55Z

It looks like there are still some merge conflicts.

esbrandt · 2018-04-15T08:59:15Z

It looks like there are still some merge conflicts.

New conflicts after yesterdays #64 merge, will have a look.

…ixxxdj/mixxx#1427. Update content to reflect changes.

# Conflicts: # source/chapters/djing_with_mixxx.rst # source/chapters/example_setups.rst # source/chapters/user_interface.rst Manually fixed conflicts

…s allows to use substitutions ( replacement images or text, as defined in ``source/shortcuts.rstext``) that can be included in the chapter.

Be-ing · 2018-04-15T13:29:41Z

Makefile

@@ -3,7 +3,7 @@

 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build-3
+SPHINXBUILD   = sphinx-build


Whoops, sorry that slipped into a commit.

Be-ing · 2018-04-15T13:41:03Z

Thanks! I think we're good to go for the 2.1 release. Now that we have continuous deployment for the manual, we can continue to work on it after the release. There is always more work to do, but this is a good state for packaging the PDF for the release.

esbrandt added 30 commits June 18, 2017 13:16

Add `VS Code to the list of Editors supporting reST syntax highligh…

97af234

…ting

Add link to `pip

9a09346

Add hint on how to update outdated dependencies using pip

13ea524

Do not recommend to install Sphinx 1.2.3 over 1.3.1, the mentioned Gr…

b5ce1e1

…aphviz related bug was fixed in http://www.sphinx-doc.org/en/stable/changes.html#release-1-3-2-released-nov-29-2015. Just install the latest version.

Update some links in Readme.md

acf6699

Do not deep-link to potentially outdated Transifex Client executables…

223b495

… for Windows. List recommended ways of installing the client.

Formating

077dc08

Update copyright notice for 2017

3580509

Revert "Revert "Add info on CUP mode , see mixxxdj/mixxx#1010""

2d4ded1

This reverts commit 1d99f83.

Revert "Revert "v2.1 requires an Intel Mac running Mac OS X 10.8 or n…

76f829b

…ewer , see"" This reverts commit 8564b02.

Fix typo

d58f0b9

Update translation sources fab i18n_update_source_translations

292e913

Remove v2.0 specific versionadded and versionchanged directiv…

2020aab

…es. Add non-duplicate info to the text where applicable.

Update link to the Waveform preferences, location changed with mixxxd…

6408fbe

…j/mixxx#527

In the version history, just print a summary of changes for the previ…

58f19b2

…ous version. For even older versions, users can follow the link to the Launchpad.net page.

Show todo items in the output. Disable for release

f06b094

Add todo item for feature list

cfdb00c

Add playlist and crate file export to right-click meny in the library…

72a438c

…, see mixxxdj/mixxx#849

Add info on random sorting in the library, see mixxxdj/mixxx#908

7d043a9

Remove file that sneaked in with the last commit

0cb9878

Update list of search operators, as available in searchqueryparser, see

0f54d68

mixxxdj/mixxx#1263

Apple changed the name of their operation system from Mac OS X ( OS X…

26e755f

… respectively ) to macOS. Bulk rename all occurrences across the manual, and go with the current name.

Clarify, that you can import existing playlists from third-party prod…

f281585

…ucts into Mixxx´ playlists OR crates. Also update list of supported playlist formats, and use ``third-party`` instead of ``3rd party`` (translator trap)

Link list of supported files when importing via command line option, …

498798b

…to have it current

Adds latest additions and changes to command line options.

431b5ad

``--debugAssertBreak`` ``--logLevel`` ``--controllerDebug`` mixxxdj/mixxx#1265 mixxxdj/mixxx/mixxxdj#118 mixxxdj/mixxx#1004

Add note on BPM conversions 4/3 and 3/2, added to the BPM Options sub…

7d9cbf7

…-men mixxxdj/mixxx#1106

Add option to replace AutoDJ queue, mixxxdj/mixxx#1163

aeaed54

Make the waveform overview darker for the played portion of the track m…

a812668

…ixxxdj/mixxx#1203

Clarify that the position marker on the waveform overview differs fro…

e1093ea

…m the one on the waveform summary

Add Equalizer to the glossary

3de4c18

esbrandt added 15 commits April 14, 2018 14:32

Delete leftover from manually fixing merge conflicts

d7d134e

Add link to contributechapter in the introduction page

74b3948

Add info for multi-import of external playlists from the Playlists/Cr…

d46e553

…ates root element. See mixxxdj/mixxx#945. Emphasize, that importing from existing playlists/crates will result in bulk-adding the content to the single selected playlist/crate.

Update guilabels when importing crates/strings to the actual strings

f1cb02b

The Libraryroot item was renamed to Tracks, change all refere…

dd2e452

…nces accordingly

The Browseroot item was renamed to Computer, change all refer…

b4fdd3b

…ences accordingly

Add info for sorting keys by circle of fifths, see mixxxdj/mixxx#1000

74f384e

Add info on highlighting Playlists and Crates a track is in. See mixx…

730d29c

…xdj/mixxx#617

Improve readability for list of supported file type by grouping them …

1fce7ff

…in a table. Use :file: role to highlight file suffixes in text.

Be more precise, how the Add random button in Auto DJ view works

f3e421e

Remove outdated references specific to the 2.0.0 version

0c366e4

Add info for custom cue labels, which change the indicator in the wav…

f15990b

…eform to the format ``#:label``. See mixxxdj/mixxx#992

Add info for Recording duration widget. See mixxxdj/mixxx#1221

723aaf1

Update changed button labels in track property editor

939eeb8

Add info for option to write audio tags back into files, see mixxxdj/…

909abd2

…mixxx#728

rryan approved these changes Apr 15, 2018

View reviewed changes

esbrandt added 3 commits April 15, 2018 06:51

Back from the future, change faux version 2.10 --> 2.1.0

97aed74

Wording, address review comments

eadb875

Replace references to IRC with Zulip. Add Zulip glossary term. Addres…

7329381

…ses review comments

esbrandt added 6 commits April 15, 2018 11:10

More wording, addresses another review comment

23e4fcc

The track tables right click context menu has majorly changed after m…

8c8947b

…ixxxdj/mixxx#1427. Update content to reflect changes.

Merge remote-tracking branch 'upstream/manual-2.1.x' into manual-2.1.x

8834dac

# Conflicts: # source/chapters/djing_with_mixxx.rst # source/chapters/example_setups.rst # source/chapters/user_interface.rst Manually fixed conflicts

Again, include shortcuts.rstext at the beginning of each chapter. Thi…

338b604

…s allows to use substitutions ( replacement images or text, as defined in ``source/shortcuts.rstext``) that can be included in the chapter.

Post merge link fix

b11f5b3

Delete unused files. Unused since c57a14b

6d04451

Be-ing reviewed Apr 15, 2018

View reviewed changes

Be-ing merged commit 3705349 into mixxxdj:manual-2.1.x Apr 15, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP Manual 2.1.x updates #59

WIP Manual 2.1.x updates #59

esbrandt commented Jun 24, 2017 •

edited

Loading

rryan left a comment

rryan Apr 15, 2018

Be-ing Apr 15, 2018

rryan Apr 15, 2018

rryan Apr 15, 2018

rryan Apr 15, 2018

rryan Apr 15, 2018

rryan Apr 15, 2018

rryan Apr 15, 2018

Be-ing commented Apr 15, 2018

esbrandt commented Apr 15, 2018

Be-ing Apr 15, 2018

Be-ing commented Apr 15, 2018

		@@ -531,12 +550,19 @@ mixing or for using Mixxx as media player.

		The Auto DJ features in detail:

		.. versionadded:: 2.10

WIP Manual 2.1.x updates #59

WIP Manual 2.1.x updates #59

Conversation

esbrandt commented Jun 24, 2017 • edited Loading

TODO

rryan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Be-ing commented Apr 15, 2018

esbrandt commented Apr 15, 2018

Choose a reason for hiding this comment

Be-ing commented Apr 15, 2018

esbrandt commented Jun 24, 2017 •

edited

Loading