css and cleanup

This commit is contained in:
tooomm 2025-12-28 21:47:02 +01:00
parent a46419bde9
commit 304c15383c
8 changed files with 74 additions and 17 deletions

View file

@ -54,7 +54,7 @@ PROJECT_NUMBER = $(COCKATRICE_REF)
# for a project that appears at the top of each page and should give viewers a # for a project that appears at the top of each page and should give viewers a
# quick idea about the purpose of the project. Keep the description short. # quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "A cross-platform virtual tabletop for multiplayer card games" PROJECT_BRIEF = "A virtual tabletop for multiplayer card games"
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55 # in the documentation. The maximum height of the logo should not exceed 55
@ -1432,8 +1432,9 @@ HTML_STYLESHEET =
# documentation. # documentation.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET = doc/doxygen/theme/doxygen-awesome.css HTML_EXTRA_STYLESHEET = doc/doxygen/theme/doxygen-awesome.css \
doc/doxygen/css/hide_nav_sync.css doc/doxygen/css/hide_nav_sync.css \
doc/doxygen/css/cockatrice_docs_style.css
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note # other source files which should be copied to the HTML output directory. Note

View file

@ -1,11 +1,13 @@
@page deck_search_syntax_help Deck Search Syntax Help @page deck_search_syntax_help Deck Search Syntax Help
## Deck Search Syntax Help ## Deck Search Syntax Help
-----
The search bar recognizes a set of special commands.<br> The search bar recognizes a set of special commands.<br>
In this list of examples below, each entry has an explanation and can be clicked to test the query. Note that all In this list of examples below, each entry has an explanation and can be clicked to test the query. Note that all
searches are case insensitive. searches are case insensitive.
<dl> <dl>
<dt>Display Name (The deck name, or the filename if the deck name isn't set):</dt> <dt>Display Name (The deck name, or the filename if the deck name isn't set):</dt>
<dd>[red deck wins](#red deck wins) <small>(Any deck with a display name containing the words red, deck, and wins)</small></dd> <dd>[red deck wins](#red deck wins) <small>(Any deck with a display name containing the words red, deck, and wins)</small></dd>
<dd>["red deck wins"](#%22red deck wins%22) <small>(Any deck with a display name containing the exact phrase "red deck wins")</small></dd> <dd>["red deck wins"](#%22red deck wins%22) <small>(Any deck with a display name containing the exact phrase "red deck wins")</small></dd>
@ -42,4 +44,4 @@ searches are case insensitive.
<dt>Grouping:</dt> <dt>Grouping:</dt>
<dd><a href="#red -([[]]:100 or aggro)">red -([[]]:100 or aggro)</a> <small>(Any deck that has red in its filename but is not 100 cards or has aggro in its filename)</small></dd> <dd><a href="#red -([[]]:100 or aggro)">red -([[]]:100 or aggro)</a> <small>(Any deck that has red in its filename but is not 100 cards or has aggro in its filename)</small></dd>
</dl> </dl>

View file

@ -1,10 +1,12 @@
@page search_syntax_help Search Syntax Help @page search_syntax_help Search Syntax Help
## Search Syntax Help ## Search Syntax Help
-----
The search bar recognizes a set of special commands similar to some other card databases.<br> The search bar recognizes a set of special commands similar to some other card databases.<br>
In this list of examples below, each entry has an explanation and can be clicked to test the query. Note that all searches are case insensitive. In this list of examples below, each entry has an explanation and can be clicked to test the query. Note that all searches are case insensitive.
<dl> <dl>
<dt>Name:</dt> <dt>Name:</dt>
<dd>[birds of paradise](#birds of paradise) <small>(Any card name containing the words birds, of, and paradise)</small></dd> <dd>[birds of paradise](#birds of paradise) <small>(Any card name containing the words birds, of, and paradise)</small></dd>
<dd>["birds of paradise"](#%22birds of paradise%22) <small>(Any card name containing the exact phrase "birds of paradise")</small></dd> <dd>["birds of paradise"](#%22birds of paradise%22) <small>(Any card name containing the exact phrase "birds of paradise")</small></dd>
@ -65,4 +67,4 @@ In this list of examples below, each entry has an explanation and can be clicked
<dd>[o:/counter target .* spell/](#o:/counter target .* spell/) <small>(Any card text with "counter target *something* spell")</small></dd> <dd>[o:/counter target .* spell/](#o:/counter target .* spell/) <small>(Any card text with "counter target *something* spell")</small></dd>
<dd>[o:/for each .* and\/or .*/](#o:/for each .* and\/or .*/) <small>(/'s can be escaped with a \)</small></dd> <dd>[o:/for each .* and\/or .*/](#o:/for each .* and\/or .*/) <small>(/'s can be escaped with a \)</small></dd>
</dl> </dl>

View file

@ -0,0 +1,33 @@
/*
See "Awesome Doxygen CSS" theme docs:
https://jothepro.github.io/doxygen-awesome-css/md_docs_2customization.html#autotoc_md36
Adjustments here are based on the css file of the theme and variables defined there.
*/
/* Light Mode overrides */
html {
--primary-color: #33a946;
--primary-dark-color: #33a946;
--primary-light-color: #33a946;
}
/* Dark Mode overrides */
@media (prefers-color-scheme: dark) {
html:not(.light-mode) {
--primary-color: #33a946;
--primary-dark-color: #33a946;
--primary-light-color: #33a946;
}
}
/* Dark Mode overrides, defined twice to support both the dark-mode without and with doxygen-awesome-darkmode-toggle.js */
html.dark-mode {
color-scheme: dark;
--primary-color: #33a946;
--primary-dark-color: #33a946;
--primary-light-color: #33a946;
}

View file

@ -1,3 +1,16 @@
@page card_database_schema_and_parsing Card Database Schema and Parsing @page card_database_schema_and_parsing Card Database Schema and Parsing
# Card Database Schemas
Cockatrice uses `XML files` to store information of available cards to be used in the app (`cards.xml`).
The token file follows the schema of the card database (`tokens.xml`), too.
Saved decks (`<deckname>.xml`) use a different schema.
- [XSD Schema for `Card Databases`](https://github.com/Cockatrice/Cockatrice/blob/master/doc/carddatabase_v4/cards.xsd) <kbd>v4</kbd>
- [XSD Schema for `Decks`](https://github.com/Cockatrice/Cockatrice/blob/master/doc/deck.xsd) <kbd>v1</kbd>
# Card Database Parsing
TODO TODO

View file

@ -1,10 +1,8 @@
@mainpage Cockatrice Documentation @mainpage Documentation
# Welcome Welcome to the Cockatrice code documentation.
This is the **main landing page** of the Cockatrice documentation. - @subpage user_reference
- @subpage developer_reference
- Go to the @subpage user_reference page Please also check the <a href="https://cockatrice.github.io/" target="_blank" rel="noopener noreferrer">Cockatrice Webpage</a> or our <a href="https://github.com/Cockatrice/Cockatrice" target="_blank" rel="noopener noreferrer">Code Repository</a> for general information.
- Review the @subpage developer_reference
Or check out the [Cockatrice Webpage](https://cockatrice.github.io/).

View file

@ -1,9 +1,17 @@
@page user_reference User Reference @page user_reference User Reference
- @subpage search_syntax_help
- @subpage deck_search_syntax_help
## Deck Management
- @subpage creating_decks - @subpage creating_decks
- @subpage importing_decks - @subpage importing_decks
- @subpage editing_decks - @subpage editing_decks
- @subpage exporting_decks - @subpage exporting_decks
## Release Channels
- @subpage beta_release
## Syntax Help
- @subpage search_syntax_help
- @subpage deck_search_syntax_help