Sprite Factory 技术文档

1. 安装指南

安装 Sprite Factory 库非常简单，只需使用以下命令安装 Ruby gem 包即可：

$ gem install sprite-factory

此外，根据你的系统环境，你可能还需要安装图像处理库。对于 Ubuntu 系统，你可以使用以下命令安装 RMagick：

$ sudo aptitude install imageMagick libMagickWand-dev
$ sudo gem install rmagick

如果你希望使用较轻量级的 ChunkyPNG 库（仅支持 PNG 格式），可以使用以下命令安装：

$ gem install chunky_png

2. 项目的使用说明

使用 Sprite Factory 有两种方式：使用命令行脚本或直接在代码中调用 SpriteFactory 类。

使用命令行工具 sf，你需要指定包含图像的目录：

$ sf images/icons

这将在同一目录下生成 images/icons.png 和 images/icons.css 文件。

你也可以直接在 Ruby 代码中使用 SpriteFactory 类：

require 'sprite_factory'

SpriteFactory.run!('images/icons)

在 HTML 中使用 CSS sprites 时，通常使用一个 1x1 像素的透明 GIF 作为图片源 (src)。这个 GIF 文件通常命名为 s.gif，并在 CSS 中设置背景图片。

3. 项目 API 使用文档

SpriteFactory 类提供了多个可配置的选项来自定义生成过程。以下是一些主要的选项：

• :layout：指定布局算法（水平、垂直或打包）。
• :style：指定 CSS 语法（css、scss 或 sass）。
• :library：指定图像库（rmagick 或 chunkypng）。
• :selector：指定自定义 CSS 选择器。
• :cssurl：指定 CSS 图片 URL。
• :output_image：指定生成图像的输出位置。
• :output_style：指定生成样式表的输出位置。
• :pngcrush：如果可用，压缩输出图像。
• :padding：为每个精灵添加填充。
• :margin：为每个精灵添加边距。
• :width：将每个精灵的宽度固定为特定大小。
• :height：将每个精灵的高度固定为特定大小。
• :nocss：抑制输出样式表的生成。
• :nocomments：抑制输出样式表中的注释。
• :sanitizer：在生成 CSS 选择器时，剥离图像文件名中的非单词字符。

以下是一个使用这些选项的例子：

SpriteFactory.run!('images/icons', :style => :sass, :layout => :packed)

4. 项目安装方式

安装 Sprite Factory 的方式已在“安装指南”中说明，即通过安装 Ruby gem 包及相关图像库。

以上就是关于 Sprite Factory 的技术文档，希望对您使用该库有所帮助。