[Doxygen] More extra-pages for cards/developer documentation and various fixes (#6316)

* Docu stash

Took 1 hour 53 minutes

Took 5 minutes


Took 16 seconds

Took 33 seconds

* Remove file headers.

Took 8 minutes

* Group to card set.

Took 8 seconds

* More extra pages.

Took 28 seconds

* Small fix for now.

Took 3 minutes

* Expand on picture loading.

Took 44 minutes

* Fix line break breaking link.

Took 2 minutes

* Images and user documentation.

Took 1 hour 49 minutes

* Update doc/doxygen-extra-pages/developer_documentation/primer_cards.md

Co-authored-by: RickyRister <42636155+RickyRister@users.noreply.github.com>

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
Co-authored-by: RickyRister <42636155+RickyRister@users.noreply.github.com>

doc/doxygen-extra-pages/user_documentation/deck_management/creating_decks.md

@@ -0,0 +1,17 @@
+@page creating_decks Creating Decks
+
+Creating a new deck is done using either the TabDeckEditor or TabDeckEditorVisual.
+
+They can be accessed either by clicking the "Create Deck" button in the TabHome screen, which will open the default deck
+editor configured in the "User Interface" -> "Deck editor/storage settings" -> "Default deck editor type" setting, or
+by selecting "Deck Editor" or "Visual Deck Editor" under the "Tabs" application menu located at the top.
+
+# Further References
+
+See @ref editing_decks for information on how to modify the attributes and contents of a deck in the Deck Editor
+widgets.
+
+See @ref exporting_decks for information on how to store and persist your deck either in-client or to external
+services.
+
+See @ref importing_decks for information on how to import existing decks either in-client or from external services

doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks.md

@@ -0,0 +1,5 @@
+@page editing_decks Editing Decks
+
+@subpage editing_decks_classic
+
+@subpage editing_decks_visual

doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_classic.md

@@ -0,0 +1,54 @@
+@page editing_decks_classic Classic Deck Editor
+
+\image html classic_deck_editor.png width=900px
+
+# Editing Basic Deck Information
+
+Editing basic deck information is done through the deck dock widget (DeckEditorDeckDockWidget).
+
+\image html deckeditordeckdockwidget.png
+
+This widget allows editing:
+
+- The name
+- The comments
+- The banner card, which is used to represent the deck in the visual deck storage
+- The tags, which are used for filtering in the visual deck storage
+
+# Adding Cards
+
+Adding cards is done using the list of cards in the database presented in the list view on the left.
+
+\image html classic_database_display.png
+
+Cards can be added by either double-clicking an entry, pressing return with an entry selected to add it to the mainboard
+or pressing ctrl/cmd + return to add it to the sideboard.
+
+There are also buttons for these two functions on the right of the search bar above the list view.
+
+\image html classic_database_display_add_buttons.png
+
+# Modifying the Deck List
+
+To modify or remove cards in the deck list, the tree list view in the deck dock widget can be used.
+
+\image html deck_dock_deck_list.png
+
+Just above the list, at the top right, there are four buttons to manipulate the currently selected card(s):
+
+- Increment Card
+- Decrement Card
+- Remove Card
+- Switch Card between Mainboard and Sideboard
+
+\image html deck_dock_deck_list_buttons.png
+
+Additionally, there is a combo box above the list, which may be used to change how cards are grouped in the list
+display. This is only for visual display and does not affect how the list is saved.
+
+\image html deck_dock_deck_list_group_by.png
+
+# Modifying printings
+
+For more information on modifying the printings in a deck see @ref editing_decks_printings
+

doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_printings.md

@@ -0,0 +1 @@
+@page editing_decks_printings Printing Selector

doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_visual.md

@@ -0,0 +1,71 @@
+@page editing_decks_visual Visual Deck Editor
+
+# Editing Basic Deck Information
+
+Editing basic deck information is done through the deck dock widget (DeckEditorDeckDockWidget).
+
+\image html deckeditordeckdockwidget.png
+
+This widget allows editing:
+
+- The name
+- The comments
+- The banner card, which is used to represent the deck in the visual deck storage
+- The tags, which are used for filtering in the visual deck storage
+
+# Adding Cards
+
+Adding cards is done by either using the "Quick search and add card" search bar at the top of the "Visual Deck View" tab
+or by clicking on a picture of a card in the "Visual Database Display" tab.
+
+See @ref visual_database_display for more information on how to utilize the visual database display.
+
+# Modifying the Deck List
+
+To modify or remove cards in the deck list, the tree list view in the deck dock widget can be used.
+
+Just above the list, at the top right, there are four buttons to manipulate the currently selected card(s):
+
+- Increment Card
+- Decrement Card
+- Remove Card
+- Switch Card between Mainboard and Sideboard
+
+Additionally, there is a combo box above the list, which may be used to change how cards are grouped in the list
+display. This is only for visual display and does not affect how the list is saved.
+
+# Modifying the visual deck layout
+
+The visual deck editor displays cards visually, as opposed to simply in list form in the Deck Dock Widget. Each entry in
+the deck list is represented by a picture. These entries are grouped together under their respective sub-groups.
+Sub-groups may be collapsed (i.e. the pictures contained within them are hidden) by clicking on the name of the group in
+the banner.
+
+Cards may either be displayed in a "Flat" layout, which displays each picture next to each other and ensures full
+visibility for each card, or in an "Overlap" layout, which overlaps cards on top of each other (leaving the top 20% of
+the card uncovered so names remain readable) and arranges them in stacks to save space and allow for an easy overview.
+
+Additionally, it is possible to change how the cards in the deck list are grouped by selecting a different grouping
+method from the combo box, either in the top left of the "Visual Deck View" tab or above the list view in the deck dock
+widget.
+
+Furthermore, it is possible to change how the cards are sorted within the sub-group. This is done by clicking on the
+button with the cogwheel icon next to the combo box that adjusts grouping in the top left of the "Visual Deck View" tab.
+This presents a list of available sort criteria, which may be rearranged to change their priorities.
+
+# Modifying printings
+
+For more information on modifying the printings in a deck see @ref editing_decks_printings
+
+# Deck Analytics
+
+The visual deck editor offers a "Deck Analytics" tab, which displays information about:
+
+- The mana curve
+- The mana devotion
+- The mana base
+
+# Sample Hand
+
+The visual deck editor offers a "Sample Hand" tab, which allows simulating drawing a configurable amount of cards from
+the deck, which reduces the need to launch a single player game for testing purposes.

doc/doxygen-extra-pages/user_documentation/deck_management/exporting_decks.md

@@ -0,0 +1,95 @@
+@page exporting_decks Exporting Decks
+
+# Where to export?
+
+There are two screens in the client which can be used to import decks, depending on the context.
+
+- The deck editor tab
+- The deck storage tab (not to be confused with the visual deck storage tab)
+
+# The Deck Editor Tab
+
+The deck editor tabs (Classic and Visual) offer three ways of export a deck:
+
+- To a file on your local storage
+- To your clipboard
+- To an online service
+
+## Local File Storage
+
+To save a deck to a file on your local storage, select the "Save Deck" action in the "Deck Editor" or "Visual Deck
+Editor" menu in the application menu bar at the top of the screen. Alternatively, you can use the shortcut Ctrl/Cmd + S
+to access this action.
+
+Selecting this action will open a file picker dialog provided by your operating system. Simply enter a file name and
+select a format (.cod is recommended) and confirm.
+
+Just below the "Save Deck" action described above is the "Save Deck as..." option, which allows saving an existing file
+under a different filename, which is useful for saving a different version or copy of a deck.
+
+## From Clipboard
+
+To save a deck to your clipboard, select the "Save deck to clipboard..." action in the "Deck Editor" or "Visual Deck
+Editor" menu in the application menu bar at the top of the screen. Alternatively, you can use the shortcut Ctrl/Cmd +
+Shift + C or Ctrl/Cmd + Shift + R to access this action.
+
+Selecting this action will save the currently open deck list to your clipboard.
+
+Saving the decklist without annotations will export the decklist, with each card being described in the following format
+
+```
+CARD_AMOUNT CARD_NAME (SET_SHORT_NAME) CARD_COLLECTOR_NUMBER
+```
+
+There is also the (no set info) option, which will simply export each card as
+
+```
+CARD_AMOUNT CARD_NAME
+```
+
+Mainboard and sideboard are delimited by a newline like so:
+
+```
+1 MainboardCard
+1 OtherMainboardCard
+
+1 SideboardCard
+```
+
+Saving the decklist as annotated will insert comments (marked with // in front of them).
+It will first insert the name and any comments associated with the deck before separating each deck section into its own
+newline delimited and annotated group.
+
+Example: TODO: Adjust this to be non mtg based.
+
+```
+// Deck Name
+
+// Deck Comment
+
+// 10 Maindeck
+// 6 Artifact
+2 The Darkness Crystal (FIN) 335
+2 The Fire Crystal (FIN) 337
+2 Black Mage's Rod (FIN) 90
+
+// 6 Sorcery
+2 Nibelheim Aflame (FIN) 339
+4 Cornered by Black Mages (FIN) 93
+
+// 6 Sideboard
+// 6 Creature
+SB: 4 Blazing Bomb (FIN) 130
+SB: 1 Garland, Knight of Cornelia (FIN) 221
+SB: 1 Undercity Dire Rat (FIN) 123
+```
+
+## From an online service
+
+To export a deck to an online service, select the "Send deck to online service..." action in the "Deck Editor" or "
+Visual Deck Editor" menu in the application menu bar at the top of the screen.
+
+Selecting this action will open your browser with the selected service open and the deck list information from the
+client supplied to it.
+
+Currently supported services are DeckList and TappedOut.

doc/doxygen-extra-pages/user_documentation/deck_management/importing_decks.md

@@ -0,0 +1,62 @@
+@page importing_decks Importing Decks
+
+# Where to import?
+
+There are three screens in the client which can be used to import decks, depending on the context.
+
+- The deck editor tab
+- The pre-game lobby tab
+- The deck storage tab (not to be confused with the visual deck storage tab)
+
+# The Deck Editor Tab
+
+The deck editor tabs (Classic and Visual) offer three ways of importing a deck:
+
+- From a file on your local storage
+- From your clipboard
+- From an online service
+
+## Local File Storage
+
+To load a deck from a file on your local storage, select the "Load Deck" action in the "Deck Editor" or "Visual Deck
+Editor" menu in the application menu bar at the top of the screen. Alternatively, you can use the shortcut Ctrl/Cmd + O
+to access this action.
+
+Selecting this action will open a file picker dialog provided by your operating system. Simply select a supported file
+here and it will be loaded.
+
+Just below the "Load Deck" action described above is the "Load recent deck" option, which keeps a record of the last 10
+loaded decks for quick access.
+
+## From Clipboard
+
+To load a deck from your clipboard, select the "Load deck from clipboard..." action in the "Deck Editor" or "Visual Deck
+Editor" menu in the application menu bar at the top of the screen. Alternatively, you can use the shortcut Ctrl/Cmd +
+Shift + V to access this action.
+
+Selecting this action will open a new text editor dialog with the contents of your clipboard pasted inside it.
+
+The import dialog expects each line to be a card with the following format:
+
+TODO
+
+Each card should be on a separate line and there should be no empty lines between cards. The first empty line between
+two blocks of cards will be considered as the divider between mainboard and sideboard.
+
+Selecting "Parse Set Name and Number (if available)" will automatically parse these options and attempt to resolve them
+to valid provider IDs found in the card database. If this option is unselected, Cockatrice will import all cards as
+versions without provider IDs, which means they will display to everyone according to their own user defined set
+preferences, rather than being the same defined printing for everyone.
+
+## From an online service
+
+To load a deck from an online service, select the "Load deck from online service..." action in the "Deck Editor" or "
+Visual Deck Editor" menu in the application menu bar at the top of the screen.
+
+Selecting this action will open a dialog containing the contents of your clipboard pasted into it. If your clipboard
+currently contains a supported URL, the dialog will accept it and close on its own, otherwise you may adjust the URL and
+confirm.
+
+The action will automatically import the deck from the online service without any other required user action.
+
+Currently supported services are Archidekt, Deckstats, Moxfield, and TappedOut.

doc/doxygen-extra-pages/user_documentation/index.md

@@ -1,4 +1,13 @@
 @page user_reference User Reference
 
 @subpage search_syntax_help
-@subpage deck_search_syntax_help
+
+@subpage deck_search_syntax_help
+
+@subpage creating_decks
+
+@subpage importing_decks
+
+@subpage editing_decks
+
+@subpage exporting_decks