From 6c0a1b17219649549bd4e9fccc3159c450468033 Mon Sep 17 00:00:00 2001 From: Eric Bollens Date: Tue, 16 Oct 2012 16:55:52 -0700 Subject: [PATCH] Move blockquote readme to doc folder and sym link for template README.md [#125] --- doc/module/entity/Blockquote.md | 34 +++++++++++++++++++++++++++ template/entity/blockquote/README.md | 35 +--------------------------- 2 files changed, 35 insertions(+), 34 deletions(-) create mode 100644 doc/module/entity/Blockquote.md mode change 100644 => 120000 template/entity/blockquote/README.md diff --git a/doc/module/entity/Blockquote.md b/doc/module/entity/Blockquote.md new file mode 100644 index 0000000..0bf1f22 --- /dev/null +++ b/doc/module/entity/Blockquote.md @@ -0,0 +1,34 @@ +# Blockquote + +## Definition + +A blockquote represents quoted content that is semantically offset from the rest of the content on a page. The content +is generally offset due to length or significance. + +## Usages + +* Quote an outside source (for example, an excerpt from a blog article or a passage from a book) +* Redundantly quote a noteworthy portion of a current body of text to call attention to the quoted content + +## Features + +The `blockquote` element can either be used on its own for a simple quote without attribution or nested within a +`figure` element with a corresponding `figcaption` to create a quote with attribution. Attribution for a blockquote +can not be placed within a `blockquote` element (http://www.whatwg.org/specs/web-apps/current-work/#the-blockquote-element). + +If the quoted material is located at an accessible URL, provide the URL within the `cite` attribute of the `blockquote` +element. + +By default, a blockquote will stretch to fit the full width of its container. However, the optional `callout` CSS +class can be added to create a smaller, more compact style that will allow wrapped text for quotes that are intended +to be "callout" quotes dropped throughout a body of text (see the second usage above). + +The `text-right` CSS class can be applied to the containing `figure` or `blockquote` element to the align the contents of the +blockquote to the right. + +## Responsive Considerations + +* The standard blockquote will stretch to fit the full width of its container, so adapting to fit a responsive design +is not a major concern. Some stylistic padding and margin may be removed to create a more condensed look and feel for +the smallest viewports +* The `callout` version of the blockquote should change to fit the full width of its container for smaller viewports \ No newline at end of file diff --git a/template/entity/blockquote/README.md b/template/entity/blockquote/README.md deleted file mode 100644 index 0bf1f22..0000000 --- a/template/entity/blockquote/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Blockquote - -## Definition - -A blockquote represents quoted content that is semantically offset from the rest of the content on a page. The content -is generally offset due to length or significance. - -## Usages - -* Quote an outside source (for example, an excerpt from a blog article or a passage from a book) -* Redundantly quote a noteworthy portion of a current body of text to call attention to the quoted content - -## Features - -The `blockquote` element can either be used on its own for a simple quote without attribution or nested within a -`figure` element with a corresponding `figcaption` to create a quote with attribution. Attribution for a blockquote -can not be placed within a `blockquote` element (http://www.whatwg.org/specs/web-apps/current-work/#the-blockquote-element). - -If the quoted material is located at an accessible URL, provide the URL within the `cite` attribute of the `blockquote` -element. - -By default, a blockquote will stretch to fit the full width of its container. However, the optional `callout` CSS -class can be added to create a smaller, more compact style that will allow wrapped text for quotes that are intended -to be "callout" quotes dropped throughout a body of text (see the second usage above). - -The `text-right` CSS class can be applied to the containing `figure` or `blockquote` element to the align the contents of the -blockquote to the right. - -## Responsive Considerations - -* The standard blockquote will stretch to fit the full width of its container, so adapting to fit a responsive design -is not a major concern. Some stylistic padding and margin may be removed to create a more condensed look and feel for -the smallest viewports -* The `callout` version of the blockquote should change to fit the full width of its container for smaller viewports \ No newline at end of file diff --git a/template/entity/blockquote/README.md b/template/entity/blockquote/README.md new file mode 120000 index 0000000..383a4c1 --- /dev/null +++ b/template/entity/blockquote/README.md @@ -0,0 +1 @@ +../../../doc/module/entity/Blockquote.md \ No newline at end of file