From 866095e43e981541b7f88d8151501ae2b3168140 Mon Sep 17 00:00:00 2001 From: Chris Eppstein Date: Fri, 30 Apr 2010 09:39:46 -0700 Subject: [PATCH] [Docs] Documentation for table mixins. --- .../content/examples/compass/tables/all.haml | 8 +++++ .../examples/compass/tables/all/markup.haml | 33 +++++++++++++++++++ .../compass/tables/all/stylesheet.sass | 8 +++++ .../examples/compass/tables/borders.haml | 8 +++++ .../compass/tables/borders/markup.haml | 33 +++++++++++++++++++ .../compass/tables/borders/stylesheet.sass | 5 +++ .../examples/compass/tables/scaffolding.haml | 8 +++++ .../compass/tables/scaffolding/markup.haml | 33 +++++++++++++++++++ .../tables/scaffolding/stylesheet.sass | 4 +++ .../examples/compass/tables/striping.haml | 8 +++++ .../compass/tables/striping/markup.haml | 33 +++++++++++++++++++ .../compass/tables/striping/stylesheet.sass | 5 +++ .../reference/compass/utilities/tables.haml | 2 +- .../tables/alternating_rows_and_columns.haml | 9 ++--- .../compass/utilities/tables/borders.haml | 9 +++-- .../compass/utilities/tables/scaffolding.haml | 7 ++-- 16 files changed, 200 insertions(+), 13 deletions(-) create mode 100644 doc-src/content/examples/compass/tables/all.haml create mode 100644 doc-src/content/examples/compass/tables/all/markup.haml create mode 100644 doc-src/content/examples/compass/tables/all/stylesheet.sass create mode 100644 doc-src/content/examples/compass/tables/borders.haml create mode 100644 doc-src/content/examples/compass/tables/borders/markup.haml create mode 100644 doc-src/content/examples/compass/tables/borders/stylesheet.sass create mode 100644 doc-src/content/examples/compass/tables/scaffolding.haml create mode 100644 doc-src/content/examples/compass/tables/scaffolding/markup.haml create mode 100644 doc-src/content/examples/compass/tables/scaffolding/stylesheet.sass create mode 100644 doc-src/content/examples/compass/tables/striping.haml create mode 100644 doc-src/content/examples/compass/tables/striping/markup.haml create mode 100644 doc-src/content/examples/compass/tables/striping/stylesheet.sass diff --git a/doc-src/content/examples/compass/tables/all.haml b/doc-src/content/examples/compass/tables/all.haml new file mode 100644 index 00000000..9b77dc2c --- /dev/null +++ b/doc-src/content/examples/compass/tables/all.haml @@ -0,0 +1,8 @@ +--- +title: Compass Table Example +description: How to use the table mixins. +framework: compass +stylesheet: compass/utilities/_tables.scss +example: true +--- += render "partials/example" diff --git a/doc-src/content/examples/compass/tables/all/markup.haml b/doc-src/content/examples/compass/tables/all/markup.haml new file mode 100644 index 00000000..4839ab6b --- /dev/null +++ b/doc-src/content/examples/compass/tables/all/markup.haml @@ -0,0 +1,33 @@ +.example + %table{:cellspacing => "0"} + %thead + %tr.odd + %th Title + %th One + %th Two + %th Three + %th Four + %th Row Total + %tbody + %tr.even + %th Single + %td.numeric 1.0 + %td.numeric 2.0 + %td.numeric 3.0 + %td.numeric 4.0 + %td.numeric 10.0 + %tr.odd + %th Tens + %td.numeric 10.0 + %td.numeric 20.0 + %td.numeric 30.0 + %td.numeric 40.0 + %td.numeric 100.0 + %tfoot + %tr.even + %th Total + %td.numeric 11.0 + %td.numeric 22.0 + %td.numeric 33.0 + %td.numeric 44.0 + %td.numeric 110.0 diff --git a/doc-src/content/examples/compass/tables/all/stylesheet.sass b/doc-src/content/examples/compass/tables/all/stylesheet.sass new file mode 100644 index 00000000..d3ac2155 --- /dev/null +++ b/doc-src/content/examples/compass/tables/all/stylesheet.sass @@ -0,0 +1,8 @@ +@import "compass/utilities/tables" +.example + table + $table-color : #7a98c6 + +table-scaffolding + +inner-table-borders(1px, darken($table-color, 40%)) + +outer-table-borders(2px) + +alternating-rows-and-columns($table-color, adjust-hue($table-color, -120deg), #222) diff --git a/doc-src/content/examples/compass/tables/borders.haml b/doc-src/content/examples/compass/tables/borders.haml new file mode 100644 index 00000000..8371c02d --- /dev/null +++ b/doc-src/content/examples/compass/tables/borders.haml @@ -0,0 +1,8 @@ +--- +title: Compass Table Borders Example +description: How to use the table border mixins. +framework: compass +stylesheet: compass/utilities/tables/_borders.scss +example: true +--- += render "partials/example" diff --git a/doc-src/content/examples/compass/tables/borders/markup.haml b/doc-src/content/examples/compass/tables/borders/markup.haml new file mode 100644 index 00000000..4839ab6b --- /dev/null +++ b/doc-src/content/examples/compass/tables/borders/markup.haml @@ -0,0 +1,33 @@ +.example + %table{:cellspacing => "0"} + %thead + %tr.odd + %th Title + %th One + %th Two + %th Three + %th Four + %th Row Total + %tbody + %tr.even + %th Single + %td.numeric 1.0 + %td.numeric 2.0 + %td.numeric 3.0 + %td.numeric 4.0 + %td.numeric 10.0 + %tr.odd + %th Tens + %td.numeric 10.0 + %td.numeric 20.0 + %td.numeric 30.0 + %td.numeric 40.0 + %td.numeric 100.0 + %tfoot + %tr.even + %th Total + %td.numeric 11.0 + %td.numeric 22.0 + %td.numeric 33.0 + %td.numeric 44.0 + %td.numeric 110.0 diff --git a/doc-src/content/examples/compass/tables/borders/stylesheet.sass b/doc-src/content/examples/compass/tables/borders/stylesheet.sass new file mode 100644 index 00000000..efb8516b --- /dev/null +++ b/doc-src/content/examples/compass/tables/borders/stylesheet.sass @@ -0,0 +1,5 @@ +@import "compass/utilities/tables/borders" +.example + table + +inner-table-borders(1px, #7a98c6) + +outer-table-borders(2px) diff --git a/doc-src/content/examples/compass/tables/scaffolding.haml b/doc-src/content/examples/compass/tables/scaffolding.haml new file mode 100644 index 00000000..b015c4db --- /dev/null +++ b/doc-src/content/examples/compass/tables/scaffolding.haml @@ -0,0 +1,8 @@ +--- +title: Compass Table Scaffolding Example +description: How to use the table scaffolding mixins. +framework: compass +stylesheet: compass/utilities/tables/_scaffolding.scss +example: true +--- += render "partials/example" diff --git a/doc-src/content/examples/compass/tables/scaffolding/markup.haml b/doc-src/content/examples/compass/tables/scaffolding/markup.haml new file mode 100644 index 00000000..4839ab6b --- /dev/null +++ b/doc-src/content/examples/compass/tables/scaffolding/markup.haml @@ -0,0 +1,33 @@ +.example + %table{:cellspacing => "0"} + %thead + %tr.odd + %th Title + %th One + %th Two + %th Three + %th Four + %th Row Total + %tbody + %tr.even + %th Single + %td.numeric 1.0 + %td.numeric 2.0 + %td.numeric 3.0 + %td.numeric 4.0 + %td.numeric 10.0 + %tr.odd + %th Tens + %td.numeric 10.0 + %td.numeric 20.0 + %td.numeric 30.0 + %td.numeric 40.0 + %td.numeric 100.0 + %tfoot + %tr.even + %th Total + %td.numeric 11.0 + %td.numeric 22.0 + %td.numeric 33.0 + %td.numeric 44.0 + %td.numeric 110.0 diff --git a/doc-src/content/examples/compass/tables/scaffolding/stylesheet.sass b/doc-src/content/examples/compass/tables/scaffolding/stylesheet.sass new file mode 100644 index 00000000..58e312eb --- /dev/null +++ b/doc-src/content/examples/compass/tables/scaffolding/stylesheet.sass @@ -0,0 +1,4 @@ +@import "compass/utilities/tables/scaffolding" +.example + table + +table-scaffolding diff --git a/doc-src/content/examples/compass/tables/striping.haml b/doc-src/content/examples/compass/tables/striping.haml new file mode 100644 index 00000000..fa0cf29d --- /dev/null +++ b/doc-src/content/examples/compass/tables/striping.haml @@ -0,0 +1,8 @@ +--- +title: Compass Table Striping Example +description: How to use the alternating-rows-and-columns mixin. +framework: compass +stylesheet: compass/utilities/tables/_alternating-rows-and-columns.scss +example: true +--- += render "partials/example" diff --git a/doc-src/content/examples/compass/tables/striping/markup.haml b/doc-src/content/examples/compass/tables/striping/markup.haml new file mode 100644 index 00000000..4839ab6b --- /dev/null +++ b/doc-src/content/examples/compass/tables/striping/markup.haml @@ -0,0 +1,33 @@ +.example + %table{:cellspacing => "0"} + %thead + %tr.odd + %th Title + %th One + %th Two + %th Three + %th Four + %th Row Total + %tbody + %tr.even + %th Single + %td.numeric 1.0 + %td.numeric 2.0 + %td.numeric 3.0 + %td.numeric 4.0 + %td.numeric 10.0 + %tr.odd + %th Tens + %td.numeric 10.0 + %td.numeric 20.0 + %td.numeric 30.0 + %td.numeric 40.0 + %td.numeric 100.0 + %tfoot + %tr.even + %th Total + %td.numeric 11.0 + %td.numeric 22.0 + %td.numeric 33.0 + %td.numeric 44.0 + %td.numeric 110.0 diff --git a/doc-src/content/examples/compass/tables/striping/stylesheet.sass b/doc-src/content/examples/compass/tables/striping/stylesheet.sass new file mode 100644 index 00000000..04335907 --- /dev/null +++ b/doc-src/content/examples/compass/tables/striping/stylesheet.sass @@ -0,0 +1,5 @@ +@import "compass/utilities/tables/alternating-rows-and-columns" +.example + table + $table-color : #7a98c6 + +alternating-rows-and-columns($table-color, adjust-hue($table-color, -120deg), #222) diff --git a/doc-src/content/reference/compass/utilities/tables.haml b/doc-src/content/reference/compass/utilities/tables.haml index 3f62adb7..0832d667 100644 --- a/doc-src/content/reference/compass/utilities/tables.haml +++ b/doc-src/content/reference/compass/utilities/tables.haml @@ -13,4 +13,4 @@ classnames: --- - render 'reference' do %p - Lorem ipsum dolor sit amet. + Style helpers for your tables. diff --git a/doc-src/content/reference/compass/utilities/tables/alternating_rows_and_columns.haml b/doc-src/content/reference/compass/utilities/tables/alternating_rows_and_columns.haml index 9a94363c..a6012b03 100644 --- a/doc-src/content/reference/compass/utilities/tables/alternating_rows_and_columns.haml +++ b/doc-src/content/reference/compass/utilities/tables/alternating_rows_and_columns.haml @@ -1,15 +1,16 @@ --- -title: Compass Alternating Rows and Columns -crumb: Alternating Rows And Columns +title: Compass Table Striping +crumb: Table Striping framework: compass stylesheet: compass/utilities/tables/_alternating-rows-and-columns.scss layout: core nav_stylesheet: compass/_utilities.scss +meta_description: Add striping to a table. classnames: - reference - core - utilities --- - render 'reference' do - %p - Lorem ipsum dolor sit amet. + :markdown + Add striping to a table in both directions based on a few colors. diff --git a/doc-src/content/reference/compass/utilities/tables/borders.haml b/doc-src/content/reference/compass/utilities/tables/borders.haml index 909eb58d..f8784e45 100644 --- a/doc-src/content/reference/compass/utilities/tables/borders.haml +++ b/doc-src/content/reference/compass/utilities/tables/borders.haml @@ -1,15 +1,14 @@ --- -title: Compass Borders -crumb: Borders +title: Compass Table Borders +crumb: Table Borders framework: compass stylesheet: compass/utilities/tables/_borders.scss layout: core nav_stylesheet: compass/_utilities.scss +meta_description: Add borders to a table. classnames: - reference - core - utilities --- -- render 'reference' do - %p - Lorem ipsum dolor sit amet. += render 'reference' diff --git a/doc-src/content/reference/compass/utilities/tables/scaffolding.haml b/doc-src/content/reference/compass/utilities/tables/scaffolding.haml index 85378e3c..4501b8b5 100644 --- a/doc-src/content/reference/compass/utilities/tables/scaffolding.haml +++ b/doc-src/content/reference/compass/utilities/tables/scaffolding.haml @@ -1,10 +1,11 @@ --- -title: Compass Scaffolding -crumb: Scaffolding +title: Compass Table Scaffolding +crumb: Table Scaffolding framework: compass stylesheet: compass/utilities/tables/_scaffolding.scss layout: core nav_stylesheet: compass/_utilities.scss +meta_description: Basic styling of tables to get you started. classnames: - reference - core @@ -12,4 +13,4 @@ classnames: --- - render 'reference' do %p - Lorem ipsum dolor sit amet. + Basic styling of tables to get you started.