]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
Remove redundant documentation on base-typography
authorkarland <anders-betrachtet@online.de>
Sun, 20 Nov 2016 01:05:33 +0000 (02:05 +0100)
committerkarland <anders-betrachtet@online.de>
Sun, 20 Nov 2016 01:05:33 +0000 (02:05 +0100)
It seems that base-typography has been renamed into typography-base some
time ago and then existed in parallel.

docs/pages/base-typography.md [deleted file]
docs/pages/index.md

diff --git a/docs/pages/base-typography.md b/docs/pages/base-typography.md
deleted file mode 100644 (file)
index 06b7730..0000000
+++ /dev/null
@@ -1,266 +0,0 @@
----
-title: Base Typography
-description: Typography in Foundation 6 is meant to make your life easier by providing clean, attractive, simple default styles for all of the most basic typographical elements.
-sass:
-  - scss/typography/_base.scss
-  - scss/typography/_print.scss
-tags:
-  - paragraph
-  - heading
-  - link
-  - definition
-  - blockquote
-  - abbreviation
-  - acronym
-  - code
-  - keystroke
----
-
-## Paragraphs
-
-This is a paragraph. Paragraphs are preset with a font size, line height and spacing to match the overall vertical rhythm. To show what a paragraph looks like this needs a little more content&mdash;so, did you know that there are storms occurring on Jupiter that are larger than the Earth? Pretty cool. Use the `<strong>` and `<em>` tags to denote text that should be displayed or read with emphasis. Browsers will bold and italicize them, while screen readers will read the words with *emphasis*.
-
-<div class="callout primary">
-  <p>If the emphasis of a phrase is important, don't make the emphasis purely visual&mdash;use the `<em>` or `<strong>` tags to mark it as well. Both of these tags have built-in styles, but there's no harm in adding additional styles in specific contexts.</p>
-</div>
-
-```html
-<p>This is a paragraph. Paragraphs are preset with a font size, line height and spacing to match the overall vertical rhythm. To show what a paragraph looks like this needs a little more content so, did you know that there are storms occurring on Jupiter that are larger than the Earth? Pretty cool. Wrap strong around type to <strong>make it bold!</strong>. You can also use em to <em>italicize your words</em>.</p>
-```
-
----
-
-## Header
-
-Foundation includes styles for all headings&mdash;they're balanced and sized along a modular scale.
-
-<div class="callout primary">
-  <p>Avoid skipping heading levels when structuring your document, as it confuses screen readers. For example, after using an <code>&lt;h2&gt;</code> in your code, the next heading used should be either <code>&lt;h2&gt;</code> or <code>&lt;h3&gt;</code>. If you need a heading to look bigger or smaller to match a specific style, use CSS to override the default size.</p>
-</div>
-
-```html_example
-<h1>h1. This is a very large header.</h1>
-<h2>h2. This is a large header.</h2>
-<h3>h3. This is a medium header.</h3>
-<h4>h4. This is a moderate header.</h4>
-<h5>h5. This is a small header.</h5>
-<h6>h6. This is a tiny header.</h6>
-```
-
----
-
-### Header Sizes
-
-The framework includes two typographic scales&mdash;one uses a narrow range of sizes for small-sized screens, and the other uses a wider range of sizes for medium- and large-sized screens. You can change these scales, or add new ones for other breakpoints, by editing the `$header-sizes` map in your project's <a href="sass.html#the-settings-file">Settings File</a>.
-
-Header  | Default | Medium and up
---------|---------|--------------
-`<h1>`  | 24px    | 48px
-`<h2>`  | 20px    | 40px
-`<h3>`  | 19px    | 31px
-`<h4>`  | 18px    | 25px
-`<h5>`  | 17px    | 20px
-`<h6>`  | 16px    | 16px
-
----
-
-### Small Header Segments
-
-By inserting a `<small>` element into a header Foundation will scale the header font size down for an inline element, allowing you to use this for subtitles or other secondary header text.
-
-```html_example
-<h3>Foundation for Sites <small>Version 6</small></h3>
-```
-
----
-
-## Links
-
-Links are very standard, and the color is preset to the Foundation primary color. <a href="global.html">Learn more about Foundation's global colors.</a>
-
-<div class="callout">
-  <p>To make links screen reader-friendly, avoid using vague words like "here" or "read more" within link text. The text of the link itself should adequately describe where the link goes.</p>
-</div>
-
-```html
-<p>Links are very standard, and the color is preset to the Foundation primary color. <a href="global.html">Learn more about Foundation's global colors.</a></p>
-```
-
----
-
-## Dividers
-
-Use dividers to define thematic breaks between paragraphs. To denote the end of one section of a page and the start of another, it's better to use the `<section>` tag.
-
-```html
-<hr>
-```
-
----
-
-## Unordered Lists
-
-Use an unordered list to... *list things*, if the order of the items doesn't matter.
-
-```html_example
-<ul>
-  <li>List item with a much longer description or more content.</li>
-  <li>List item</li>
-  <li>List item
-    <ul>
-      <li>Nested list item</li>
-      <li>Nested list item</li>
-      <li>Nested list item</li>
-    </ul>
-  </li>
-  <li>List item</li>
-  <li>List item</li>
-  <li>List item</li>
-</ul>
-```
-
----
-
-## Ordered Lists
-
-Use an `<ol>` when creating a list where the order of the items is important, like ranking pizza toppings from best to worst.
-
-```html_example
-<ol>
-  <li>Cheese (essential)</li>
-  <li>Pepperoni</li>
-  <li>Bacon
-    <ol>
-      <li>Normal bacon</li>
-      <li>Canadian bacon</li>
-    </ol>
-  </li>
-  <li>Sausage</li>
-  <li>Onions</li>
-  <li>Mushrooms</li>
-</ol>
-```
-
----
-
-## Definition Lists
-
-A definition list (`<dl>`) is used to display name-value pairs, like metadata or a dictionary definition. Each term (`<dt>`) is paired with one or more definitions (`<dd>`).
-
-```html_example
-<dl>
-  <dt>Time</dt>
-  <dd>The indefinite continued progress of existence and events in the past, present, and future regarded as a whole.</dd>
-  <dt>Space</dt>
-  <dd>A continuous area or expanse that is free, available, or unoccupied.</dd>
-  <dd>The dimensions of height, depth, and width within which all things exist and move.</dd>
-</dl>
-```
-
----
-
-## Blockquotes
-
-Sometimes other people say smart things, and you may want to mention those things with a quote. We've got you covered.
-
-```html_example
-<blockquote>
-  Those people who think they know everything are a great annoyance to those of us who do.
-  <cite>Isaac Asimov</cite>
-</blockquote>
-```
-
----
-
-## Abbreviations
-
-Use the `<abbr>` tag to annotate a shortened term. Abbreviations must always have a `title` attribute which clarifies the full term.
-
-```html_example
-<p>In my dream last night, I saw <abbr title="John Ronald Reuel">J. R. R.</abbr> Tolkien and George <abbr title="Raymond Richard">R. R.</abbr> Martin hanging out on Sunset <abbr title="Boulevard">Blvd</abbr>.</p>
-```
-
----
-
-## Code
-
-Format references to code with the `<code>` tag.
-
-```html_example
-Remember to escape angle brackets when printing HTML: <code>&lt;div&gt;</code>
-```
-
----
-
-## Keystrokes
-
-Use the `<kbd>` element to annotate a key stroke or combination.
-
-```html_example
-<p>Press <kbd>Cmd+Q</kbd> (or <kbd>Ctrl+Q</kbd> on Windows) to play Half-Life 3.</p>
-```
-
----
-
-## Accessibility
-
-Text is core to the content of your page, so making it accessible to everyone is important. Here are some general guidelines to follow.
-
-### Text vs. Images
-
-Prefer using actual text over text inside a graphic. Assistive technologies can't read an image, and the text in an image can't be resized by a browser, like normal text. If an image has text that needs to be read, add it in the `alt` attribute of the image.
-
-```html
-<img src="assets/img/buy-now.jpg" alt="Buy now">
-```
-
----
-
-### Contrast
-
-The contrast between the color of an element's text and its background should be high enough that low-vision users can read it. **The minimum recommended contrast ratio is 4.5:1.** There are no automated tools that can effectively check this for you, but if you aren't sure about a specific color combination, you can run it through one of many color contrast checkers, such as [WebAIM's color contrast checker](http://webaim.org/resources/contrastchecker/).
-
-Google Chrome's [Accessibility Developer Tools](https://chrome.google.com/webstore/detail/accessibility-developer-t/fpkknkljclfencbdbgkenhalefipecmb?hl=en) also includes a contrast checker. By selecting an element in the inspector, you can see if the contrast meets the minimum standards.
-
-<img class="thumbnail" src="assets/img/a11y/chrome-a11y-inspector.jpg" alt="Screenshot of Google Chrome's Accessibility Tools">
-
----
-
-### Type Size
-
-When possible, use the `rem` and `em` units to size everything. Not just font size, but also padding, margins, and any length value. This ensures that your design scales up and down uniformly if the user changes their browser's text size. It's common for vision-impaired users to resize their browser up to 200% zoom.
-
-We use the `rem` unit nearly everywhere in Foundation, and even wrote a Sass function to make it a little easier. The `rem-calc()` function can take one or more pixel values and convert them to proper `rem` values.
-
-```scss
-.element {
-  width: rem-calc(300);
-  padding: rem-calc(10 16);
-}
-```
-
----
-
-### More Resources
-
-- [WebAIM: Fonts](http://webaim.org/techniques/fonts/)
-- [WebAIM: Links and HyperText](http://webaim.org/techniques/hypertext/)
-- [WebAIM: Writing Clearly and Simply](http://webaim.org/techniques/semanticstructure/)
-- [WebAIM: Color Contrast Checker](http://webaim.org/resources/contrastchecker/)
-
----
-
-## Print Styles
-
-Foundation includes print styles developed by HTML5 Boilerplate to give you some basic print-specific styles. These are activated when you print through a media query. It includes:
-
-- Clearing out backgrounds, box shadows and text shadows
-- Appending link URLs after the anchor text
-- Adding borders to `<blockquote>` and `<pre>` elements
-- Page cleanup and window minimization
-
-On top of that, Foundation includes a couple of simple classes you can use to control elements printing, or not printing. Simply attach `.show-for-print` to an element to only show when printing, and `.hide-for-print` to hide something when printing.
-
-<div class="callout primary">
-  <p>Print styles use `!important` to ensure they aren't overriden by more specific selectors. This framework conscientiously avoids using `!important` declarations. This is one of the few components that does.</p>
-</div>
index 90d685ebd677ca2fa685ac1bef3e965a8738689d..69580c4645c59deeceeae063c27eb1b59193c900 100644 (file)
@@ -89,7 +89,7 @@ Get to know the pieces of Foundation.
     <section>
       <h4>Typography</h4>
       <ul>
-        <li><a href="base-typography.html">Base Styles</a></li>
+        <li><a href="typography-base.html">Base Styles</a></li>
         <li><a href="typography-helpers.html">Helper Classes</a></li>
       </ul>
     </section>