mixxxdj / manual Goto Github PK

Images linked from the controller documentation on the wiki are missing from the manual.

I checked out manual HEAD and tried to make a pdf, and got:

! Package pdftex.def Error: File `chapters/../_static/Mixxx-112-LateNight-Effects-Deck.png' not found.

Did someone forget to git add some files?

Any plans to put v 2.0 into the MAS?

Looks like the old v 1.10 from 2011 is no longer available. Currently we link to https://itunes.apple.com/us/app/mixxx/id413756578?mt=12 , which is broken

The item you've requested is not currently available in the U.S. store.

See https://bugs.launchpad.net/mixxx/+bug/804700

mixxxdj/mixxx#465

These are new in 1.12. I don't fully understand the differences.

Framework - mixxxdj/mixxx#180

Graphic EQ Effect - mixxxdj/mixxx#303

We should stop encouraging people to include style information inside the skin xml. I added a basic "deprecated" message to the style element, but many many bits of example code show the style tag in use. These should be removed, and paragraph text edited to match.

Suddenly:
Pushing to https://[email protected]/mixxxdj/manual.git remote: Permission to mixxxdj/manual.git denied. fatal: unable to access 'https://[email protected]/mixxxdj/manual.git/': The requested URL returned error: 403 - Forbidden

Whats going on here guys, anything i should know of?

Following the addition of the awesome key detection feature into Mixxx, see mixxxdj/mixxx#47, we should explain the feature to our users.

need to explain that while it can help with tracks with crazy bpm floating, but that it can't be edited and may cause problems with syncing and looping under certain circumstances.

We have some stuff to do before the 2.3 release.

• Document cue colors and palette editor/replace tool (#127)
• Document Intro/Outro cues (#323)
• Document AutoDJ changes (#323)
• Document Deck Cloning (#330)
• Update all screenshots to new default theme
• Update the Version History
• ... (feel free to edit this post and add more items)

Must have
Follow up to mixxxdj/mixxx#180

Forbidden

You don't have permission to access this resource.
Apache/2.4.29 (Ubuntu) Server at mixxx.org Port 80

Same when trying to reach https://mixxx.org/manual/

Follow up to mixxxdj/mixxx#166

While merged, there are some issues with the original PR. Once this is solved, add info to LB section,

Currently, all information are in one line per row. This leads to hidden columns and horizontal scrolling. The images inside rows are squeezed.

In the old style, the tables followed the bookstyle/APA, which provides better readability imo.

NEW

Old

• Headphone Delay, mixxxdj/c5e00a30362375ad1dc8a442d6d6514081dd2af8
• Master Delay, mixxxdj/c5e00a30362375ad1dc8a442d6d6514081dd2af8
• Multi-Soundcard Sync, mixxxdj/mixxx#219
• Master Mix, mixxxdj/mixxx#229
• Keylock Engine, mixxxdj/mixxx#236
• Master Mono, mixxxdj/mixxx#315

mixxxdj/mixxx#47

It seems the manual is translated in many languages, but short of building it myself with Sphinx I can't find a way to have a translated version of it...

I guess I would expect translated versions to be built and displayed online https://mixxx.org/manual/xx_XX/latest/...

Expose the Hide tracks > Purge hidden tracks workflow
https://bugs.launchpad.net/mixxx/+bug/1452992

Warning: local() encountered an error (return code 1) while executing 'pdflatex -interaction=nonstopmode Mixxx-Manual.tex'

PDF builds currently return 1 all the time even though they produce PDFs. This prevents us from being able to block the manual build when a real error occurs. We should fix the problems that are causing the PDF build to exit 1.

There is no documentation about how to use mic ducking and the difference between manual and auto modes.

https://bugs.launchpad.net/mixxx/+bug/1764609

I'm currently writing a sphinx extension that allows us to build multiple versions of the manual.

What tags/branches do we need? I guess all tags and the master branch. I'll mark the tag with the highest version number as the latest version.

We can use that information to show a warning for all other tags that this is an outdated version of the manual. For all branches we can show a warning that it's a development version.

Can we switch to standard versioning tag names (v2.2.3 instead of release-2.2.3)? That would make parsing easier and will look better in the version switcher.

Would be great if an experienced visually impaired Mixxx user could write a manual chapter about how to DJ with Mixxx, targeted to visually impaired Dj's.

https://bugs.launchpad.net/mixxx/+bug/1898451

A new section in Advanced Topics should be written for the MIDI mapping GUI.

4 channel sound cards are recommended, so they should be depicted in the diagrams. The current diagrams depict a Behringer U-Control UCA202/222 or U-Phono 202, which are 2 channel output sound cards. I suggest changing the diagrams to depict a generic representation of a sound card rather than a particular model.

Follow up to mixxxdj/mixxx#152

Now we have Master Sync, see mixxxdj/mixxx#10, we should explain how it works to our users.

PR #35 introduced a section of the Hardware Setup chapter for using DJ splitter cables. This section is missing a diagram.

See mixxxdj/mixxx#65

Hello 👋

The documentation about MIDI scripting states that the id parameter received in the controller's init function is what is defined in the related xml file, but actually the given value is the name of the controller that is listed in the Controllers tab in mixxx's preferences.

What the doc says :

The ID parameter of the init function is the controller id attribute from the XML file.
This can be used to identify the particular controller instance in print statements.

What is actually passed :
https://github.com/mixxxdj/mixxx/blob/fa797d239d4331d13ca73863391262612ea5d5ed/src/controllers/engine/controllerengine.cpp#L277-L282

Is it possible to fix the doc (or even better, to change mixxx behavior to match the doc ?)

The manual is lacking mention of the pass-through feature of vinyl control. Add a section describing what it is and how to use it.

Only a small portion of the Preferences window is documented in the manual. Currently, each of these sections explaining a part of the Preferences is scattered around the manual. Should a new chapter be started for the Preferences window that documents all the options?

@Pegasus-RPG , are you planning on reorganizing the Preferences window for 2.1? Should writing this manual chapter wait until then?

This can make a big difference in Mixxx's performance. Users should have some guidance to understand the differences between the options and select the best for their system.

Gui and Preferences dialog look different then in 1.11, so update all images accordingly.

The manual should explain the new normalization settings.

so we should either remove the chapter 3.1.5. Transport Controls
or
mention the buttons were removed from currents skins but can be mapped with controllers/keyboards.
A link to wiki/mixxxcontols would also help, I notice don't have that Btw that link should be added to 14.1. Adding support for your MIDI/HID Controller

The library relink function should be better described. I used it to set up a training instance on a second machine and was not certain how and after which user interaction it worked, even after reading all manual content about it.

A typical scenario is, that a harddisc is defect and the user sets up a new machine with a different library path. A step by step howto to set it up with backups of music dir and mixxx dir would be great. Keep in mind, this is a critical situation, the DJ can loose a lot of his work, when playlists and crates are not usable any more. (Analyze results the same). This would be a worst case user experience, so the manual should be more explicit here.

What I miss:

• Does the relink require a select of one library path before (even if only one library path exist)
• When does the relink happen? When I press apply in options dialog or during the next library scan? When can I see it in the location column of the playlists for prove?
• Which parts of the library are touched by the relink (playlists, crates, missing tracks, analyze results). How to prove?
• In my experience, during the next library scan after relink, mixxx takes a lot of time a one track with a path from the old location. At this moment the program seems to be stalled (my lib is large), and I had not enough patience to wait for the first try, killed the process and so the relink. Only after a full run of library scan, the relink was successful. Correct?
• for experts: what are the SQL steps in the sqlite db to fix it, when relink does not help or the db structure is partly corrupt

See here
https://mixxx.org/forums/viewtopic.php?f=3&t=9285
And here
https://github.com/mixxxdj/mixxx/blob/2b26c4697cbaae7960975fab06274912bd16cda4/src/soundio/sounddeviceportaudio.cpp#L884

mixxxdj/mixxx#364

Set EQ per deck

edit ronso0:

• mention 'per deck' setting
• explain EQ types

I asked my friend to read part of the Mixxx manual and she found the visual presentation very distracting. She said the section titles on different levels are confusing and it feels like sections end abruptly when reaching a subsection title because they look so similar.

It could be helpful to add a diagram of using a mixer with a built-in USB sound card to the vinyl control chapter.

Check that all keyboard shortcuts are properly documented where the corresponding Mixxx function is explained. Also provide an appendix with a reference list of all the available keyboard shortcuts.

Explain how Autodj crates work, follow up to mixxxdj/mixxx#18

We explain a lot of the different settings in the Djing with mixxx chapter. Eg Bpm settings. This is intuitive. It takes me a while to find the settings descriptions by just looking at the TOC of the manual.

All this stuff should be moved to Configuring Mixxx and then referenced in Djjing with Mixxx.