buckram 1.7.3 → 1.8.2

package/.idea/buckram.iml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/tests" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/buckram.iml" filepath="$PROJECT_DIR$/.idea/buckram.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/php.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MessDetectorOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCSFixerOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCodeSnifferOptionsConfiguration">
+    <option name="highlightLevel" value="WARNING" />
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PhpStanOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PsalmOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [1.8.2](https://github.com/pressbooks/buckram/compare/v1.8.1...v1.8.2) (2023-07-16)
+
+
+### Bug Fixes
+
+* update release instructions ([#332](https://github.com/pressbooks/buckram/issues/332)) ([b60dda3](https://github.com/pressbooks/buckram/commit/b60dda36f6858f2bb55e4f536abdf1080194fac0))
+
+## [1.8.1](https://github.com/pressbooks/buckram/compare/v1.8.0...v1.8.1) (2023-01-04)
+
+
+### Bug Fixes
+
+* update gitignore to avoid publish config files ([71fb1ae](https://github.com/pressbooks/buckram/commit/71fb1aefcba5807d65cd674c5a7947e5e19bbe06))
+
+## [1.8.0](https://github.com/pressbooks/buckram/compare/v1.7.3...v1.8.0) (2023-01-03)
+
+
+### Features
+
+* make Buckram compatible with latest SCSSPHP ([#304](https://github.com/pressbooks/buckram/issues/304)) ([eb087ca](https://github.com/pressbooks/buckram/commit/eb087caf75ff026253904c64f8dbab335ec593f7))
+
+
+### Bug Fixes
+
+* unset content on blank pages instead of using an empty string ([#305](https://github.com/pressbooks/buckram/issues/305)) ([e9063fb](https://github.com/pressbooks/buckram/commit/e9063fbe89947173177369a4a293eba8bea5e6a6))
+
 ## [1.7.3](https://github.com/pressbooks/buckram/compare/v1.7.2...v1.7.3) (2022-08-19)
 
 

package/README.md

@@ -1,6 +1,6 @@
 # Buckram
 
-[![License](https://badgen.net/github/license/pressbooks/buckram)](https://github.com/pressbooks/buckram/blob/main/LICENSE) [![Build Status](https://badgen.net/github/status/pressbooks/buckram)](https://github.com/pressbooks/buckram/actions) [![Latest Release](https://badgen.net/npm/v/buckram)](https://www.npmjs.com/package/buckram)
+[![License](https://badgen.net/github/license/pressbooks/buckram)](https://github.com/pressbooks/buckram/blob/production/LICENSE) [![Build Status](https://badgen.net/github/status/pressbooks/buckram)](https://github.com/pressbooks/buckram/actions) [![Latest Release](https://badgen.net/npm/v/buckram)](https://www.npmjs.com/package/buckram)
 
 Opinionated SCSS components for books (web, EPUB and PDF).
 
@@ -23,8 +23,8 @@ npm test
 
 ## Releasing
 
-[release-please](https://github.com/googleapis/release-please) will generate release notes in a PR automatically based on commits to `dev`.
+Buckram uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), enforced with [commitlint](https://commitlint.js.org/). This facilitates releasing new versions of the package via [Release Please](https://github.com/googleapis/release-please). Release notes will be automatically added to a PR based on commits to `dev`.
 
-Merging the PR to tag a new GitHub release and update [CHANGELOG.md](CHANGELOG.md).
+To cut a release, merge the current [release pull request](https://github.com/google-github-actions/release-please-action#whats-a-release-pr). This will tag a new GitHub release and update [CHANGELOG.md](CHANGELOG.md).
 
-Then, run `npm publish`.
+Then, run `npm publish` from the root of the package and enter your one-time password when prompted. For more information on publishing to npm, see the [npm publish documentation](https://docs.npmjs.com/cli/publish).

package/assets/styles/buckram.scss

@@ -1,7 +1,7 @@
 /*
  * Name: Buckram
  * x-release-please-start-version
- * Version: 1.7.3
+ * Version: 1.8.2
  * x-release-please-end
  * Description: Opinionated SCSS components for books (web, EPUB and PDF).
  */

package/assets/styles/components/_colors.scss

@@ -59,9 +59,7 @@
   table p {
     color: if-map-get($table-para-color, $type);
   }
-}
-
-@else {
+} @else {
 .front-matter,
 .part,
 .chapter,
@@ -226,12 +224,14 @@ div.sidebar {
   background-color: if-map-get($sidebar-color, $type);
 }
 
-.textbox {
+.textbox,
+.bcc-box {
   background-color: if-map-get($textbox-background-color, $type);
   border-color: if-map-get($textbox-border-color, $type);
 }
 
-.textbox.shaded {
+.textbox.shaded,
+.bcc-box.shaded {
   background-color: if-map-get($textbox-shaded-background-color, $type);
 }
 

package/assets/styles/components/_utilities.scss

@@ -6,168 +6,92 @@
 /// @param {string | map} $var - The input variable.
 /// @param {string} $type - The output format.
 @function if-map-get($var, $type) {
-  @if type-of($var) == 'map' {
+  @if type-of($var) == "map" {
     @return map-get($var, $type);
   }
-
-  @else {
-    @return $var;
-  }
+  @return $var;
 }
 
 /// This function converts a running content or page number position to the CSS3 paged media box margin declaration for the relevant page position.
 /// @param {string} $page-position - The page position: `first`, `left` or `right`.
-/// @param {string} $position - The running content or page number position.
-@function convert-position($page-position, $position) {
-  @if $position == null {
-    @return false;
-  }
-
-  @else if $position == 'top-outside-corner' {
-    @if $page-position != 'first' {
-      @return '@top-#{$page-position}-corner';
+/// @param {string} $content-position - The running content or page number position.
+@function convert-position($page-position, $content-position) {
+  @if $page-position == "first" {
+    @if $content-position == "outside-bottom" {
+      @return (left: "@left-bottom", right: "@right-bottom");
     }
-
-    @else {
-      @return false;
+    @if $content-position == "bottom-outside-corner" {
+      @return "@bottom-#{$page-position}-corner";
     }
-  }
-
-  @else if $position == 'top-outside' {
-    @if $page-position != 'first' {
-      @return '@top-#{$page-position}';
-    }
-
-    @else {
-      @return false;
-    }
-  }
-
-  @else if $position == 'top-center' {
-    @return '@top-center';
-  }
 
-  @else if $position == 'top-inside' {
-    @if $page-position == 'left' {
-      @return '@top-right';
+    @if $content-position == "bottom-outside" {
+      @return "@bottom-#{$page-position}";
     }
 
-    @else if $page-position == 'right' {
-      @return '@top-left';
+    @if $content-position == "bottom-inside" {
+      @return (left: "@bottom-right", right: "@bottom-left");
     }
-
-    @else {
-      @return false;
+  } @else {
+    @if $content-position == "top-outside-corner" {
+      @return "@top-#{$page-position}-corner";
     }
-  }
 
-  @else if $position == 'outside-top' {
-    @if $page-position != 'first' {
-      @return '@#{$page-position}-top';
+    @if $content-position == "top-outside" {
+      @return "@top-#{$page-position}";
     }
 
-    @else {
-      @return false;
+    @if $content-position == "outside-middle" {
+      @return "@#{$page-position}-middle";
     }
-  }
 
-  @else if $position == 'outside-middle' {
-    @if $page-position != 'first' {
-      @return '@#{$page-position}-middle';
+    @if $content-position == "outside-top" {
+      @return "@#{$page-position}-top";
     }
 
-    @else {
-      @return false;
+    @if $content-position == "outside-bottom" {
+      @return "@#{$page-position}-bottom";
     }
-  }
 
-  @else if $position == 'outside-bottom' {
-    @if $page-position == 'first' {
-      @return (
-        left: '@left-bottom',
-        right: '@right-bottom'
-      );
+    @if $content-position == "bottom-outside"
+      or $content-position == "bottom-inside" {
+      @return "@bottom-#{$page-position}";
     }
-    @return '@#{$page-position}-bottom';
-  }
 
-  @else if $position == 'bottom-outside-corner' {
-    @if $page-position == 'first' {
-      @return (
-        left: '@bottom-left-corner',
-        right: '@bottom-right-corner'
-      );
+    @if $content-position == "bottom-outside-corner" {
+      @return "@bottom-#{$page-position}-corner";
     }
-    @return '@bottom-#{$page-position}-corner';
   }
 
-  @else if $position == 'bottom-outside' {
-    @if $page-position == 'first' {
-      @return (
-        left: '@bottom-left',
-        right: '@bottom-right'
-      );
-    }
-    @return '@bottom-#{$page-position}';
+  @if $content-position == "top-center" {
+    @return "@top-center";
   }
 
-  @else if $position == 'bottom-center' {
-    @return '@bottom-center';
+  @if $content-position == "bottom-center" {
+    @return "@bottom-center";
   }
 
-  @else if $position == 'bottom-inside' {
-    @if $page-position == 'first' {
-      @return (
-        left: '@bottom-right',
-        right: '@bottom-left'
-      );
+  @if $content-position == "top-inside" {
+    @if $page-position == "left" {
+      @return "@top-right";
     }
-
-    @else if $page-position == 'left' {
-      @return '@bottom-right';
-    }
-
-    @else if $page-position == 'right' {
-      @return '@bottom-left';
+    @if $page-position == "right" {
+      @return "@top-left";
     }
   }
+
+  @return false;
 }
 
 /// This function determines whether a running content or page number position indicates a header or footer.
-/// @param {string} $position - The running content or page number position.
-@function head-or-foot($position) {
-  @if $position == 'top-outside-corner'
-    or $position == '@top-left-corner'
-    or $position == '@top-right-corner'
-    or $position == 'top-outside'
-    or $position == '@top-left'
-    or $position == '@top-right'
-    or $position == 'top-center'
-    or $position == '@top-center'
-    or $position == 'top-inside'
-    or $position == 'outside-top'
-    or $position == '@left-top'
-    or $position == '@right-top'
-    or $position == 'outside-middle'
-    or $position == '@left-middle'
-    or $position == '@right-middle' {
-    @return 'head';
+/// @param {string} $content-position - The running content or page number position.
+@function head-or-foot($content-position) {
+  @if str-index($content-position, "top") or
+    str-index($content-position, "middle")
+  {
+    @return "head";
+  } @else if str-index($content-position, "bottom") {
+    @return "foot";
   }
 
-  @else if $position == 'outside-bottom'
-    or $position == 'bottom-outside-corner'
-    or $position == '@bottom-left-corner'
-    or $position == '@bottom-right-corner'
-    or $position == 'bottom-outside'
-    or $position == '@bottom-left'
-    or $position == '@bottom-right'
-    or $position == 'bottom-center'
-    or $position == '@bottom-center'
-    or $position == 'bottom-inside' {
-    @return 'foot';
-  }
-
-  @else {
-    @return false;
-  }
+  @return false;
 }

package/assets/styles/components/elements/_blockquotes.scss

@@ -2,9 +2,9 @@
 /// @group elements
 ////
 
-//============================================================================//
+// ============================================================================//
 //                                Blockquotes                                 //
-//============================================================================//
+// ============================================================================//
 
 @if $type != 'web' {
   .blockquote,
@@ -21,6 +21,7 @@
     @if $type == 'prince' {
       line-height: $blockquote-line-height;
     }
+
     text-align: $blockquote-align;
   }
 }

package/assets/styles/components/elements/_body.scss

@@ -2,9 +2,9 @@
 /// @group elements
 ////
 
-//============================================================================//
+// ============================================================================//
 //                                   Body                                     //
-//============================================================================//
+// ============================================================================//
 
 @import '../utilities';
 

package/assets/styles/components/elements/_headings.scss

@@ -2,29 +2,30 @@
 /// @group elements
 ////
 
-//============================================================================//
+// ============================================================================//
 //                                 Headings                                   //
-//============================================================================//
+// ============================================================================//
 
 @import '../utilities';
 
 @mixin heading($heading) {
   #{$heading} {
-    border-bottom: map-get($_heading-border-bottom-style, $heading) if-map-get(map-get($_heading-border-bottom-width, $heading), $type) if-map-get(map-get($_heading-border-bottom-color, $heading), $type);
-    margin-top: if-map-get(map-get($_heading-margin-top, $heading), $type);
-    margin-bottom: if-map-get(map-get($_heading-margin-bottom, $heading), $type);
-    padding-bottom: if-map-get(map-get($_heading-padding-bottom, $heading), $type);
-    font-family: if-map-get(map-get($_heading-font-family, $heading), $type);
-    font-size: if-map-get(map-get($_heading-font-size, $heading), $type);
-    font-style: map-get($_heading-font-style, $heading);
-    font-weight: map-get($_heading-font-weight, $heading);
+    border-bottom: map-get($heading-border-bottom-style-map, $heading) if-map-get(map-get($heading-border-bottom-width-map, $heading), $type) if-map-get(map-get($heading-border-bottom-color-map, $heading), $type);
+    margin-top: if-map-get(map-get($heading-margin-top-map, $heading), $type);
+    margin-bottom: if-map-get(map-get($heading-margin-bottom-map, $heading), $type);
+    padding-bottom: if-map-get(map-get($heading-padding-bottom-map, $heading), $type);
+    font-family: if-map-get(map-get($heading-font-family-map, $heading), $type);
+    font-size: if-map-get(map-get($heading-font-size-map, $heading), $type);
+    font-style: map-get($heading-font-style-map, $heading);
+    font-weight: map-get($heading-font-weight-map, $heading);
     @if $type != 'epub' {
-      line-height: if-map-get(map-get($_heading-line-height, $heading), $type);
+      line-height: if-map-get(map-get($heading-line-height-map, $heading), $type);
     }
-    text-align: map-get($_heading-align, $heading);
-    text-transform: map-get($_heading-text-transform, $heading);
-    letter-spacing: if-map-get(map-get($_heading-letter-spacing, $heading), $type);
-    word-spacing: if-map-get(map-get($_heading-word-spacing, $heading), $type);
+
+    text-align: map-get($heading-align-map, $heading);
+    text-transform: map-get($heading-text-transform-map, $heading);
+    letter-spacing: if-map-get(map-get($heading-letter-spacing-map, $heading), $type);
+    word-spacing: if-map-get(map-get($heading-word-spacing-map, $heading), $type);
   }
 }
 

package/assets/styles/components/elements/_links.scss

@@ -2,9 +2,9 @@
 /// @group elements
 ////
 
-//============================================================================//
+// ============================================================================//
 //                                   Links                                    //
-//============================================================================//
+// ============================================================================//
 
 @import "../utilities";
 
@@ -18,9 +18,7 @@
   .print a {
     text-decoration: $link-text-decoration-print;
   }
-}
-
-@else {
+} @else {
   .front-matter,
   .part,
   .chapter,

package/assets/styles/components/elements/_lists.scss

@@ -2,9 +2,9 @@
 /// @group elements
 ////
 
-//============================================================================//
+// ============================================================================//
 //                                   Lists                                    //
-//============================================================================//
+// ============================================================================//
 @import "../utilities";
 
 %ol {
@@ -62,7 +62,7 @@
 
   li::before {
     counter-increment: level-1;
-    content: counter(level-1)".\A0";
+    content: counter(level-1) ".\A0";
     display: inline-block;
     text-align: right;
     width: if-map-get($ol-padding-left, $type);
@@ -75,7 +75,7 @@
 
   ol li::before {
     counter-increment: level-2;
-    content: counter(level-2, lower-alpha)".\A0";
+    content: counter(level-2, lower-alpha) ".\A0";
     min-width: if-map-get($ol-padding-left, $type);
     width: auto;
   }
@@ -87,7 +87,7 @@
 
   ol ol li::before {
     counter-increment: level-3;
-    content: counter(level-3, lower-roman)".\A0";
+    content: counter(level-3, lower-roman) ".\A0";
   }
 
   ol ol ol {
@@ -97,7 +97,7 @@
 
   ol ol ol li::before {
     counter-increment: level-4;
-    content: counter(level-4)")\A0";
+    content: counter(level-4) ")\A0";
   }
 
   ol ol ol ol {
@@ -107,7 +107,7 @@
 
   ol ol ol ol li::before {
     counter-increment: level-5;
-    content: counter(level-5, lower-alpha)")\A0";
+    content: counter(level-5, lower-alpha) ")\A0";
   }
 
   ol ol ol ol ol {
@@ -117,7 +117,7 @@
 
   ol ol ol ol ol li::before {
     counter-increment: level-6;
-    content: counter(level-6, lower-roman)")\A0";
+    content: counter(level-6, lower-roman) ")\A0";
   }
 }
 
@@ -152,7 +152,7 @@
 
   li::before {
     counter-increment: level-1;
-    content: counter(level-1, upper-roman)".\A0";
+    content: counter(level-1, upper-roman) ".\A0";
     display: inline-block;
     text-align: right;
     width: if-map-get($ol-padding-left, $type);
@@ -165,7 +165,7 @@
 
   ol li::before {
     counter-increment: level-2;
-    content: counter(level-2, upper-alpha)".\A0";
+    content: counter(level-2, upper-alpha) ".\A0";
     min-width: if-map-get($ol-padding-left, $type);
     width: auto;
   }
@@ -177,7 +177,7 @@
 
   ol ol li::before {
     counter-increment: level-3;
-    content: counter(level-3)".\A0";
+    content: counter(level-3) ".\A0";
   }
 
   ol ol ol {
@@ -187,7 +187,7 @@
 
   ol ol ol li::before {
     counter-increment: level-4;
-    content: counter(level-4, lower-alpha)".\A0";
+    content: counter(level-4, lower-alpha) ".\A0";
   }
 
   ol ol ol ol {
@@ -197,7 +197,7 @@
 
   ol ol ol ol li::before {
     counter-increment: level-5;
-    content: "("counter(level-5)")\A0";
+    content: "("counter(level-5) ")\A0";
   }
 
   ol ol ol ol ol {
@@ -207,7 +207,7 @@
 
   ol ol ol ol ol li::before {
     counter-increment: level-6;
-    content: "("counter(level-6, lower-alpha)")\A0";
+    content: "("counter(level-6, lower-alpha) ")\A0";
   }
 }
 
@@ -218,7 +218,7 @@
 
   li::before {
     counter-increment: level-1;
-    content: counter(level-1)".\A0";
+    content: counter(level-1) ".\A0";
     display: inline-block;
     text-align: right;
     width: if-map-get($ol-padding-left, $type);
@@ -231,7 +231,7 @@
 
   ol li::before {
     counter-increment: level-2;
-    content: counter(level-1)"."counter(level-2)".\A0";
+    content: counter(level-1) "."counter(level-2) ".\A0";
     min-width: if-map-get($ol-padding-left, $type);
     width: auto;
   }
@@ -243,7 +243,7 @@
 
   ol ol li::before {
     counter-increment: level-3;
-    content: counter(level-1)"."counter(level-2)"."counter(level-3)".\A0";
+    content: counter(level-1) "."counter(level-2) "."counter(level-3) ".\A0";
   }
 
   ol ol ol {
@@ -253,7 +253,7 @@
 
   ol ol ol li::before {
     counter-increment: level-4;
-    content: counter(level-1)"."counter(level-2)"."counter(level-3)"."counter(level-4)".\A0";
+    content: counter(level-1) "."counter(level-2) "."counter(level-3) "."counter(level-4) ".\A0";
   }
 
   ol ol ol ol {
@@ -263,7 +263,7 @@
 
   ol ol ol ol li::before {
     counter-increment: level-5;
-    content: counter(level-1)"."counter(level-2)"."counter(level-3)"."counter(level-4)"."counter(level-5)".\A0";
+    content: counter(level-1) "."counter(level-2) "."counter(level-3) "."counter(level-4) "."counter(level-5) ".\A0";
   }
 
   ol ol ol ol ol {
@@ -273,7 +273,7 @@
 
   ol ol ol ol ol li::before {
     counter-increment: level-6;
-    content: counter(level-1)"."counter(level-2)"."counter(level-3)"."counter(level-4)"."counter(level-5)"."counter(level-6)"\A0";
+    content: counter(level-1) "."counter(level-2) "."counter(level-3) "."counter(level-4) "."counter(level-5) "."counter(level-6) "\A0";
   }
 }
 
@@ -326,7 +326,7 @@
     margin-top: if-map-get($li-li-margin-top, $type);
   }
 
-  @include generic-ordered-lists();
+  @include generic-ordered-lists;
 
   dl dt {
     @extend %dt;
@@ -403,7 +403,7 @@
       @extend %decimal;
     }
 
-    @include generic-ordered-lists();
+    @include generic-ordered-lists;
   }
 
   dl dt {