github-migration/compass
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added some anchor tags for easy linking

Browse Source
This commit is contained in:
Scott Davis 2011-03-25 21:25:27 -04:00
parent 365fc5d68f
commit c2015635dc
3 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc-src/Gemfile.lock
View File

@ -8,7 +8,7 @@ GIT
PATH PATH
remote: .. remote: ..
specs: specs:
compass (0.11.beta.4.3d9365e) compass (0.11.beta.4.365fc5d)
chunky_png (~> 1.1.0) chunky_png (~> 1.1.0)
sass (>= 3.1.0.alpha.249) sass (>= 3.1.0.alpha.249)

13
doc-src/content/help/tutorials/configuration-reference.markdown
View File

@ -9,7 +9,7 @@ classnames:
The compass configuration file is a ruby file, which means that we can do some The compass configuration file is a ruby file, which means that we can do some
clever things if we want to. But don’t let it frighten you; it’s really quite clever things if we want to. But don’t let it frighten you; it’s really quite
easy to set up your project. easy to set up your project.
<a name="basic-format"></a>
## Basic format ## Basic format
Most configuration properties are a simple assignment to a configuration property. Most configuration properties are a simple assignment to a configuration property.
@ -35,11 +35,12 @@ There are two kinds of composite values:
It is a comma delimited list of associations surrounded by curly brackets. It is a comma delimited list of associations surrounded by curly brackets.
An association is two values separated by `=>`. E.g. `{:foo => "aaa", :bar => "zzz"}` An association is two values separated by `=>`. E.g. `{:foo => "aaa", :bar => "zzz"}`
<a name="comments"></a>
## Comments ## Comments
Use the hash sign `#` to comment out everything from the hash sign to the end Use the hash sign `#` to comment out everything from the hash sign to the end
of the line. of the line.
<a name="import-note-windows-users"></a>
## Import Note for Windows Users ## Import Note for Windows Users
The backslash character (`\`) is a special character in a string delimited by The backslash character (`\`) is a special character in a string delimited by
@ -47,6 +48,7 @@ double quotes (`"`). If you are working with folders in your paths, you should
either use **single quotes** to delimit your strings or escape your backslash either use **single quotes** to delimit your strings or escape your backslash
by doubling it like `"some\\path"`. by doubling it like `"some\\path"`.
<a name="loading-compass-plugins"></a>
## Loading Compass Plugins ## Loading Compass Plugins
Compass relies on the ruby `require` mechanism to load other libraries of code. Compass relies on the ruby `require` mechanism to load other libraries of code.
@ -59,11 +61,13 @@ Example:
require 'ninesixty' require 'ninesixty'
require 'susy' require 'susy'
<a name="overriding-configuration-settings"></a>
## Overriding Configuration Settings ## Overriding Configuration Settings
When using the compass command line, configuration options that you set on the When using the compass command line, configuration options that you set on the
command line will override the corresponding settings in your configuration file. command line will override the corresponding settings in your configuration file.
<a name="inspecting-configuration-settings-passed-via-the-command-line"></a>
## Inspecting Configuration Settings passed via the Command Line ## Inspecting Configuration Settings passed via the Command Line
When using the compass command line, configuration options that you set on the When using the compass command line, configuration options that you set on the
@ -78,7 +82,7 @@ Then you can inspect the value like so:
Values that are not set on the CLI will be `nil` even though they will have a default value Values that are not set on the CLI will be `nil` even though they will have a default value
later on. later on.
<a name="configuration-properties"></a>
## Configuration Properties ## Configuration Properties
<table> <table>
@ -278,6 +282,7 @@ later on.
</tr> </tr>
</table> </table>
<a name="configuration-functions"></a>
## Configuration Functions ## Configuration Functions
**`add_import_path`** – Call this function to add a path to the list of sass import **`add_import_path`** – Call this function to add a path to the list of sass import
@ -336,7 +341,7 @@ more than once. Example:
This code will be called if the file is added, updated, or removed. Be sure to check for existence This code will be called if the file is added, updated, or removed. Be sure to check for existence
to avoid crashing the watcher in the case where the file has been removed. to avoid crashing the watcher in the case where the file has been removed.
<a name="callbacks"></a>
## Callbacks ## Callbacks
**`on_sprite_saved`** -- Pass this function a block of code that gets executed after a sprite is saved to disk. The block will be passed the filename. Can be invoked more then once. Example: **`on_sprite_saved`** -- Pass this function a block of code that gets executed after a sprite is saved to disk. The block will be passed the filename. Can be invoked more then once. Example:

1
doc-src/content/help/tutorials/spriting.markdown
View File

@ -52,6 +52,7 @@ simple naming convention for your sprites so that you they are easy to remember
should never have to care what the is name of the generated sprite map, nor where a sprite should never have to care what the is name of the generated sprite map, nor where a sprite
is located within it. is located within it.
<a name="selector-control"></a>
## Selector Control ## Selector Control
If you want control over what selectors are generated, it is easy to do. In this example, If you want control over what selectors are generated, it is easy to do. In this example,