diff --git a/CHANGELOG.md b/CHANGELOG.md index 4d96b89..b76a0a5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,9 @@ Squib follows [semantic versioning](http://semver.org). Features: * Unit conversion supports mm (#161) +Docs: +* Provide previews of each built-in template on the docs (#163) + Bugs: * Fresh installs of Squib were broken due to two hidden dependencies, gio2 and gobject-introspection. (#172) * Embedding icons in text show unicode placeholders on some OSs. This is a workaround until we get a better solution for embedding icons. See #170, #171, and #176. For that matter, see #103, #153, and #30 if you really want the whole story. diff --git a/docs/_static/css/squibdocs.css b/docs/_static/css/squibdocs.css index 0a92db5..e393fdc 100644 --- a/docs/_static/css/squibdocs.css +++ b/docs/_static/css/squibdocs.css @@ -16,3 +16,8 @@ code.code_img{ code.code_img_small{ width: 33%; } + +.figure{ + border: 1pt solid black; + box-shadow: 5px 5px 8px #333; +} diff --git a/docs/layouts.rst b/docs/layouts.rst index c93c51c..8062c93 100644 --- a/docs/layouts.rst +++ b/docs/layouts.rst @@ -227,6 +227,61 @@ If your layout file is not found in the current directory, Squib will search for Contributions in this area are particularly welcome!! +The following depictions of the layouts are generated with `this script `_ + +fantasy.yml +~~~~~~~~~~~ + +.. raw:: html + + + +https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/fantasy.yml + +economy.yml +~~~~~~~~~~~ + +.. raw:: html + + + +https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/economy.yml + +tuck_box.yml +~~~~~~~~~~~ + +Based on TheGameCrafter's template. + +.. raw:: html + + + +https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/tuck_box.yml + + +hand.yml +~~~~~~~~~~~ + +.. raw:: html + + + +https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/hand.yml + +playing_card.yml +~~~~~~~~~~~ + +.. raw:: html + + + +https://github.com/andymeneely/squib/tree/master/lib/squib/layouts/playing_card.yml + See Layouts in Action --------------------- diff --git a/samples/layouts/_output/.gitignore b/samples/layouts/_output/.gitignore new file mode 100644 index 0000000..a5fd22c --- /dev/null +++ b/samples/layouts/_output/.gitignore @@ -0,0 +1,2 @@ +# Ignore outputs in directory, but keep the directory to suppress warning +*.png diff --git a/samples/layouts_builtin.rb b/samples/layouts/builtin_layouts.rb similarity index 58% rename from samples/layouts_builtin.rb rename to samples/layouts/builtin_layouts.rb index 92b6bbe..cc49a61 100644 --- a/samples/layouts_builtin.rb +++ b/samples/layouts/builtin_layouts.rb @@ -42,10 +42,33 @@ Squib::Deck.new(layout: 'economy.yml') do save_png prefix: 'layouts_builtin_economy_' end -# Stitch together a deck of all the above examples -Squib::Deck.new(cards: 2) do - Dir.glob('_output/layouts_builtin_*.png').each.with_index do |file, i| - png file: file, range: i +Squib::Deck.new(layout: 'hand.yml') do + background color: 'white' + %w(title bonus1 bonus2 bonus3 bonus4 bonus5 description + snark art).each do |icon| + text str: icon.capitalize, layout: icon, + hint: :red, valign: 'middle', align: 'center' end - save_sheet prefix: 'layouts_builtinsheet_' + save_png prefix: 'layouts_builtin_hand_' +end + +Squib::Deck.new(layout: 'playing-card.yml') do + background color: 'white' + text str: "A\u2660", layout: :bonus_ul, font: 'Sans bold 100', hint: :red + text str: "A\u2660", layout: :bonus_lr, font: 'Sans bold 100', hint: :red + text str: 'artwork here', layout: :art, hint: :red + save_png prefix: 'layouts_builtin_playing_card_' +end + +Squib::Deck.new(layout: 'tuck_box.yml', width: 2325, height: 1950) do + background color: 'white' + rect layout: :top_rect + rect layout: :bottom_rect + rect layout: :right_rect + rect layout: :left_rect + rect layout: :back_rect + rect layout: :front_rect + curve layout: :front_curve + + save_png prefix: 'layouts_builtin_tuck_box_' end diff --git a/samples/custom-layout.yml b/samples/layouts/custom-layout.yml similarity index 100% rename from samples/custom-layout.yml rename to samples/layouts/custom-layout.yml diff --git a/samples/custom-layout2.yml b/samples/layouts/custom-layout2.yml similarity index 100% rename from samples/custom-layout2.yml rename to samples/layouts/custom-layout2.yml diff --git a/samples/layouts/expected_layouts_builtin_economy_00.png b/samples/layouts/expected_layouts_builtin_economy_00.png new file mode 100644 index 0000000..4413f19 Binary files /dev/null and b/samples/layouts/expected_layouts_builtin_economy_00.png differ diff --git a/samples/layouts/expected_layouts_builtin_fantasy_00.png b/samples/layouts/expected_layouts_builtin_fantasy_00.png new file mode 100644 index 0000000..62ffe52 Binary files /dev/null and b/samples/layouts/expected_layouts_builtin_fantasy_00.png differ diff --git a/samples/layouts/expected_layouts_builtin_hand_00.png b/samples/layouts/expected_layouts_builtin_hand_00.png new file mode 100644 index 0000000..6bcd38b Binary files /dev/null and b/samples/layouts/expected_layouts_builtin_hand_00.png differ diff --git a/samples/layouts/expected_layouts_builtin_playing_card_00.png b/samples/layouts/expected_layouts_builtin_playing_card_00.png new file mode 100644 index 0000000..8b8b5c7 Binary files /dev/null and b/samples/layouts/expected_layouts_builtin_playing_card_00.png differ diff --git a/samples/layouts/expected_layouts_builtin_tuck_box_00.png b/samples/layouts/expected_layouts_builtin_tuck_box_00.png new file mode 100644 index 0000000..ae8e6f2 Binary files /dev/null and b/samples/layouts/expected_layouts_builtin_tuck_box_00.png differ diff --git a/samples/layouts.rb b/samples/layouts/layouts.rb similarity index 98% rename from samples/layouts.rb rename to samples/layouts/layouts.rb index bd27c34..d8f073c 100644 --- a/samples/layouts.rb +++ b/samples/layouts/layouts.rb @@ -57,7 +57,6 @@ Squib::Deck.new(layout: 'hand.yml') do text str: icon.capitalize, layout: icon, hint: :red, valign: 'middle', align: 'center' end - png file: 'pokercard.png', alpha: 0.5 save_png prefix: 'layout_builtin_hand_' end diff --git a/samples/layouts/shiny-purse.png b/samples/layouts/shiny-purse.png new file mode 100644 index 0000000..477ef93 Binary files /dev/null and b/samples/layouts/shiny-purse.png differ diff --git a/samples/layouts/spanner.svg b/samples/layouts/spanner.svg new file mode 100644 index 0000000..1f3a747 --- /dev/null +++ b/samples/layouts/spanner.svg @@ -0,0 +1,91 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + +