Skip to content

Commit

Permalink
Merge pull request #129 from mannylopez/doc-update
Browse files Browse the repository at this point in the history
update links/language for the rest of Calcite Web
  • Loading branch information
paulcpederson committed Mar 31, 2015
2 parents 22e31c6 + 7bb4d03 commit b95a1c0
Show file tree
Hide file tree
Showing 16 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/source/color/_grayscale.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Grayscale
Calcite Web has mostly deals with large-field layouts and a broader range of visual communication, including small interfaces and long format reading. With this in mind, Calcite Web's grayscale differs from that of Calcite Desktop.
Calcite Web mostly deals with large-field layouts and a broader range of visual communication, including small interfaces and long format reading. With this in mind, Calcite Web's grayscale differs from that of Calcite Desktop.

Short, semantic names provide a broad range of tones across a smooth color ramp, with much attention paid to avoiding spectrum crunch at either end of the scale. All grays are completely neutral in hue, so may be used with either warm of cold color schemes.
4 changes: 2 additions & 2 deletions docs/source/color/_overview.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<h1 class="leader-0" id="overview">Color</h1>

An extensive set of color variables are set up inside of config. Color names are generally semantic and simple, making them very easy to remember. Color variables are references like any other sass variable:
An extensive set of color variables are set up inside of config. Color names are generally semantic and simple, making them very easy to remember. Color variables are references like any other Sass variable:

```scss
.element-to-style{
color: $gray;
}
```
```
2 changes: 1 addition & 1 deletion docs/source/color/_type-colors.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ $link-color: $blue;
$link-hover: $light-blue;
```

In writing SASS it's often easier to remember `$type-color` is the color of type than it is to remember the specific grayscale value that is the default for type.
In writing Sass it's often easier to remember `$type-color` is the color of type than it is to remember the specific grayscale value that is the default for type.

4 changes: 2 additions & 2 deletions docs/source/color/_ui-colors.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## UI Colors

Calcite web exposes a set of SASS variables for the UI palette. Each color has three values, light, regular, and dark.
Calcite web exposes a set of Sass variables for the UI palette. Each color has three values: light, regular, and dark.

There is also a [color sass object](../sass/#colors) that defines a set of colors for programatic iteration using SASS loops.
There is also a [color Sass object](../sass/#colors) that defines a set of colors for programatic iteration using Sass loops.
2 changes: 1 addition & 1 deletion docs/source/components/_loader.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## Loader
The loader element is a placeholder while content is being retreived or rendered. By default, the loader will display none and requires an `is-active` class to display.
The loader element is a placeholder while content is being retreived or rendered. By default, the loader is set to `display: none;` and requires an `is-active` class to display.
2 changes: 1 addition & 1 deletion docs/source/components/_panels.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Panels

Panels are useful to draw attention to or contain certain text on a page. They are simple containers, which can be used to help guide users through the visual hierarchy of your design.
Panels are useful to draw attention or contain certain text on a page. They are simple containers, which can be used to help guide users through the visual hierarchy of your design.
2 changes: 1 addition & 1 deletion docs/source/components/_tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ By default, a large table breaking your layout will horizontally scroll when it
</div>
```

This causes tables that are too wide for the layout to be constrained and scroll horizontally.
Tables that are too wide for the layout will be constrained and scroll horizontally.
2 changes: 1 addition & 1 deletion docs/source/components/_text-inputs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Text Inputs

All text inputs are styled by default. They receive a 1px border, a CSS3 transition, and a very distinct :focus style which helps provide feedback to the user while they engage with a form. The size of the forms and buttons are calibrated to they can exist in-line to each other.
All text inputs are styled by default. They receive a 1px border, a CSS3 transition, and a very distinct `:focus` style which helps provide feedback to the user while they engage with a form. The size of the forms and buttons are calibrated to they can exist in-line to each other.

2 changes: 1 addition & 1 deletion docs/source/components/sample-code/_panels.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div class="panel {{modifier}}">
<h4>This is a panel.</h4>
<p>Normal, dark, or white are the options</p>
</div>
</div>
2 changes: 1 addition & 1 deletion docs/source/icons/_font.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

The monochromatic icon set is delivered as an icon font. Icon fonts have several advantages such as the ability to quickly change their color, and the fact that icon fonts size themselves to be proportional to the text you place them with.

Monochromatic icons are generally 'interface' icons, and are named after the *action* you'd like to illustrate, instead of the *noun* the icon represents. For example, the delete icon has a class of `icon-delete` (the action) and not `icon-trash` (the noun). The reason for this is that if we decide another icon describes the action or idea better than the current one, we cna change it without breaking people's existing code.
Monochromatic icons are generally 'interface' icons, and are named after the *action* you'd like to illustrate, instead of the *noun* the icon represents. For example, the delete icon has a class of `icon-delete` (the action) and not `icon-trash` (the noun). The reason for this is that if we decide another icon describes the action or idea better than the current one, we can change it without breaking existing code.
2 changes: 1 addition & 1 deletion docs/source/icons/_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Icons in Calcite Web come in two different flavors: one color and multi-color. The one color (or monochromatic) icon set is delivered as an icon font. The multi-color icons are delivered as a set of SVG icons with corresponsponding icon classes.

Both sets can be called in the same way from your html. to display a download icon, for example:
Both sets can be called in the same way from your html. to display a download icon. For example:

```html
<span class="icon-download"></span>
Expand Down
2 changes: 1 addition & 1 deletion docs/source/patterns/sample-code/_modals.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ <h3>Modal!</h3>
</div>
</div>

<a class="js-modal-toggle btn" data-modal="foo" href="#">Show Modal</a>
<a class="js-modal-toggle btn" data-modal="foo" href="#">Show Modal</a>
4 changes: 2 additions & 2 deletions docs/source/sass/_overview.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<h1 class="leader-0" id="overview">SASS</h1>

Using Calcite Web as a SASS library is very powerful. After you successfully import the library (see [the getting started page](../) you can fully customize and use all of the Calcite Web Framework.
Using Calcite Web as a Sass library is very powerful. After you successfully import the library (see [the getting started page](../) you can fully customize and use all of the Calcite Web Framework.

## Custom Build

Calcite comes with the ability to only generate the css you actually need for your project. Class generation is controlled by setting the following variables to `true` or `false`. Setting all of these variables to `false` will prevent Calcite Web from generating **any** css classes while still exposing the complete set of mixins.

For example, if didn't want to export the css for any of the type helpers, you would simply set the `$include-type` variable to false:
For example, if didn't want to export the css for any of the type helpers, you would simply set the `$include-type` variable to `false;`

```
@import "calcite-web";
Expand Down
2 changes: 1 addition & 1 deletion docs/source/sass/_unicode-variables.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Unicode Variables

SASS Unicode variables provide a simple way to display unicode characters as content in css declarations.
Sass Unicode variables provide a simple way to display unicode characters as content in css declarations.
4 changes: 2 additions & 2 deletions docs/source/sass/_utility-mixins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Utility mixins are used to construct complicated behaviors for [components](../components) and [patterns](../patterns), provide baseline functionality for doc elements, and take care of browser prefixing.

Most utility mixins are borrowed from [Bourbon](http://bourbon.io/). Where mixins share a name, they are the same code base.
Most utility mixins are borrowed from [Bourbon](http://bourbon.io/). If mixins share a name, then they share the same code base.

Use the utility mixins inside the selector you with to apply the styles to, passing the arguments in if required. For example, to apply a clearfix to an element with the class `.my-div`, the use the following SASS:
Use the utility mixins inside the selector you wish to apply the styles to, passing the arguments in if required. For example, to apply a clearfix to an element with the class `.my-div`, the use the following Sass:

```scss
.my-div {
Expand Down
2 changes: 1 addition & 1 deletion docs/source/sass/_variables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Variables

Calcite Web comes with several variables. These variables represent project-standard configurations of different aspects. For example, `$baseline` can be used in your SASS to set a property to the default typographic baseline of Calcite Web.
Calcite Web comes with several variables. These variables represent project-standard configurations of different aspects. For example, `$baseline` can be used in your Sass to set a property to the default typographic baseline of Calcite Web.

These variables can also be configured in your own project to change the library for project-specific applications.

Expand Down

0 comments on commit b95a1c0

Please sign in to comment.