diff --git a/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks.md b/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks.md index d8b96dac3..030811306 100644 --- a/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks.md +++ b/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks.md @@ -2,4 +2,6 @@ @subpage editing_decks_classic -@subpage editing_decks_visual \ No newline at end of file +@subpage editing_decks_visual + +@subpage editing_decks_printings \ No newline at end of file diff --git a/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_printings.md b/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_printings.md index 27ade3f63..737575ae5 100644 --- a/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_printings.md +++ b/doc/doxygen-extra-pages/user_documentation/deck_management/editing_decks_printings.md @@ -1 +1,122 @@ -@page editing_decks_printings Printing Selector \ No newline at end of file +@page editing_decks_printings Printing Selector + +\image html printing_selector.png + +# Purpose + +The PrintingSelector allows editing the PrintingInfo associated with CardInfo%s contained in DeckList%s. + +As described in PrintingInfo, a CardInfo can have different variations contained within the same or different CardSet%s. + +PrintingSelector allows the user to choose a variation, as well as pinning a variation to be used as the preferred +printing in all cases where the 'default' or 'most preferred' image should be shown. + +# Pre-requisites (User Interface) + +To use the printing selector, ensure that you are using the Post-ProviderID change behavior (Checkbox as shown in the +image). + +\image html printing_selector_pre_providerid.png + +\attention This is the default behavior, unless you have explicitly changed it, in which case you will have seen a +warning as follows. Once again, checking this box will *disable* the new behavior and revert you to the legacy system +without the printing selector. + +Disabling the printing selector: + +\image html printing_selector_enable.png + +Enabling the printing selector: + +\image html printing_selector_disable.png + +# Pre-requisites (Card Database) + +The PrintingSelector requires each underlying CardInfo object to have a entry with a *unique* providerID attribute +for each variation that should be displayed. + +Here is an example, that first defines three sets, and then the 'Ace of Hearts' card with three variations. + +```xml +PKR +STD +NBR +``` + +```xml + + + + + PKR + Cockatrice Poker + Custom + 2025-11-15 + + + STD + Standard Poker + core + 2025-11-14 + + + NBR + Numbers + core + 2025-11-14 + + + + + Ace of Hearts + Ace of Hearts + + normal + front + Ace + Ace + 14 + 14 + H + H + legal + + Joker + 0 + 1 + 0 + 0 + PKR + STD + NBR + + + +``` + +# Using the Printing Selector + +To use the PrintingSelector, first select a card in the DeckEditorDeckDockWidget: + +\image html deck_dock_deck_list.png + +You may add a variation to the mainboard by clicking the + and - buttons in the top row. The bottom row will add the +variation to your sideboard. + +\image html printing_selector.png + +You can also right-click a variation to pin it, which will move it to the top of the variation list for easy access and +additionally, use it as the default printing whenever the printing isn't explicitly specified (such as adding a card +from the database in the deck editor). + +Only one printing may be pinned at a time. + +Additionally, the PrintingSelector offers a navigation bar at the bottom to navigate through cards in your deck, as well +as an option to modify the variations of cards in bulk via the 'Bulk Selection' option. + +\image html printing_selector_navigation.png + +The search bar at the top may be used to filter the displayed variations and the cogwheel may be clicked to open up +additional settings. + +\image html printing_selector_options.png diff --git a/doc/doxygen-images/printing_selector.png b/doc/doxygen-images/printing_selector.png new file mode 100644 index 000000000..c06ac90bc Binary files /dev/null and b/doc/doxygen-images/printing_selector.png differ diff --git a/doc/doxygen-images/printing_selector_disable.png b/doc/doxygen-images/printing_selector_disable.png new file mode 100644 index 000000000..8bdd8f292 Binary files /dev/null and b/doc/doxygen-images/printing_selector_disable.png differ diff --git a/doc/doxygen-images/printing_selector_enable.png b/doc/doxygen-images/printing_selector_enable.png new file mode 100644 index 000000000..2c7d05afa Binary files /dev/null and b/doc/doxygen-images/printing_selector_enable.png differ diff --git a/doc/doxygen-images/printing_selector_navigation.png b/doc/doxygen-images/printing_selector_navigation.png new file mode 100644 index 000000000..a91ed4511 Binary files /dev/null and b/doc/doxygen-images/printing_selector_navigation.png differ diff --git a/doc/doxygen-images/printing_selector_options.png b/doc/doxygen-images/printing_selector_options.png new file mode 100644 index 000000000..2079b70ac Binary files /dev/null and b/doc/doxygen-images/printing_selector_options.png differ diff --git a/doc/doxygen-images/printing_selector_pre_providerid.png b/doc/doxygen-images/printing_selector_pre_providerid.png new file mode 100644 index 000000000..a1be993ee Binary files /dev/null and b/doc/doxygen-images/printing_selector_pre_providerid.png differ