fontisan 0.2.14 → 0.2.17

data/docs/guide/color-fonts/colr-cpal.md

@@ -0,0 +1,175 @@
+---
+title: COLR/CPAL Color Fonts
+---
+
+# COLR/CPAL Color Fonts
+
+COLR/CPAL is a modern color font format using layered vector glyphs.
+
+## Overview
+
+- **COLR** — Defines glyph layers and their order
+- **CPAL** — Defines color palettes
+
+## Structure
+
+### COLR Table
+
+```ruby
+colr = font.tables['COLR']
+
+# Base glyphs (color emoji)
+base_glyphs = colr.base_glyphs
+
+# Layers for a base glyph
+layers = colr.layers_for(glyph_id)
+# Returns array of { glyph_id:, palette_index: }
+```
+
+### CPAL Table
+
+```ruby
+cpal = font.tables['CPAL']
+
+# Number of palettes
+num_palettes = cpal.num_palettes
+
+# Colors in a palette
+palette_colors = cpal.palette(0)  # First palette
+
+# Get specific color
+color = cpal.color(palette_index)
+# Returns { r:, g:, b:, a: }
+```
+
+## Working with COLR/CPAL
+
+### List Color Glyphs
+
+```ruby
+font = Fontisan::FontLoader.load('color-font.ttf')
+colr = font.tables['COLR']
+
+colr.base_glyphs.each do |glyph_id|
+  glyph_name = font.glyph_name(glyph_id)
+  puts "#{glyph_name} (#{glyph_id})"
+end
+```
+
+### Get Layer Colors
+
+```ruby
+colr = font.tables['COLR']
+cpal = font.tables['CPAL']
+
+colr.base_glyphs.each do |glyph_id|
+  puts "Glyph #{glyph_id}:"
+
+  colr.layers_for(glyph_id).each do |layer|
+    color = cpal.color(layer[:palette_index])
+    layer_name = font.glyph_name(layer[:glyph_id])
+    puts "  #{layer_name}: rgba(#{color[:r]}, #{color[:g]}, #{color[:b]}, #{color[:a]})"
+  end
+end
+```
+
+## Color Palettes
+
+### Default Palette
+
+```ruby
+cpal = font.tables['CPAL']
+
+# First palette (default)
+default_palette = cpal.palette(0)
+puts "Default palette has #{default_palette.length} colors"
+```
+
+### Multiple Palettes
+
+Some fonts have alternative color schemes:
+
+```ruby
+cpal = font.tables['CPAL']
+
+(0...cpal.num_palettes).each do |palette_index|
+  puts "Palette #{palette_index}:"
+  cpal.palette(palette_index).each_with_index do |color, i|
+    puts "  Color #{i}: rgba(#{color[:r]}, #{color[:g]}, #{color[:b]}, #{color[:a]})"
+  end
+end
+```
+
+## Conversion
+
+### Preserve COLR/CPAL
+
+```bash
+# COLR/CPAL is preserved during same-format conversion
+fontisan convert color-font.ttf --to otf --output color-font.otf
+```
+
+### Flatten to PNG
+
+```bash
+# Export color glyphs as PNG images
+fontisan export color-font.ttf --format png --output ./images/
+```
+
+## Creating COLR/CPAL
+
+Currently Fontisan focuses on reading and preserving COLR/CPAL. For creation, consider:
+
+1. Design glyphs in layers
+2. Assign palette indices
+3. Define color palettes
+4. Use font editor (Glyphs, FontForge)
+
+## Browser Support
+
+| Browser | Version |
+|---------|---------|
+| Chrome | 98+ |
+| Firefox | 105+ |
+| Safari | 15.4+ |
+| Edge | 98+ |
+
+## Validation
+
+```bash
+# Validate color font
+fontisan validate color-font.ttf
+
+# Check COLR structure
+fontisan info color-font.ttf
+```
+
+## Example
+
+### Analyze Color Emoji Font
+
+```ruby
+font = Fontisan::FontLoader.load('emoji.ttf')
+colr = font.tables['COLR']
+cpal = font.tables['CPAL']
+
+puts "Color glyphs: #{colr.base_glyphs.length}"
+puts "Palettes: #{cpal.num_palettes}"
+
+# Find glyph for specific character
+cmap = font.tables['cmap']
+glyph_id = cmap.glyph_id_for('😀')
+
+if colr.base_glyphs.include?(glyph_id)
+  puts "😀 is a color glyph"
+
+  layers = colr.layers_for(glyph_id)
+  puts "Composed of #{layers.length} layers:"
+
+  layers.each do |layer|
+    layer_name = font.glyph_name(layer[:glyph_id])
+    color = cpal.color(layer[:palette_index])
+    puts "  #{layer_name}: rgba(#{color[:r]}, #{color[:g]}, #{color[:b]})"
+  end
+end
+```

data/docs/guide/color-fonts/index.md

@@ -0,0 +1,140 @@
+---
+title: Color Fonts Overview
+---
+
+# Color Fonts Overview
+
+Fontisan supports multiple color font formats for modern typography.
+
+## Supported Formats
+
+| Format | Tables | Description |
+|--------|--------|-------------|
+| COLR/CPAL | COLR, CPAL | Layered vector glyphs |
+| sbix | sbix | Bitmap images (Apple) |
+| CBDT/CBLC | CBDT, CBLC | Bitmap images (Google) |
+| SVG | SVG | SVG embedded in font |
+
+## COLR/CPAL
+
+COLR/CPAL uses layered vector glyphs with palette-based coloring.
+
+### Advantages
+
+- **Scalable** — Vectors scale to any size
+- **Small file size** — Efficient compression
+- **Variable support** — Works with variable fonts
+- **Wide support** — Modern browsers and apps
+
+### Structure
+
+```
+COLR table:
+- Glyph layers (which glyphs make up each color glyph)
+- Layer order (back to front)
+
+CPAL table:
+- Color palettes (sets of colors)
+- Color values (RGBA for each palette entry)
+```
+
+## sbix
+
+sbix stores bitmap images at multiple resolutions (Apple format).
+
+### Advantages
+
+- **Photo-realistic** — Any image quality
+- **Multiple sizes** — Different bitmaps for different sizes
+
+### Structure
+
+```
+sbix table:
+- Strikes (image sets at different sizes)
+- Per-glyph images (PNG, JPG, etc.)
+```
+
+## CBDT/CBLC
+
+CBDT/CBLC stores bitmap images (Google/Android format).
+
+### Advantages
+
+- **Android support** — Primary Android bitmap format
+- **Multiple sizes** — Different bitmaps per ppem
+
+### Structure
+
+```
+CBLC table:
+- Location data (where each bitmap is)
+- Size information
+
+CBDT table:
+- Bitmap data (actual images)
+```
+
+## SVG Color Fonts
+
+SVG fonts embed complete SVG documents.
+
+### Advantages
+
+- **Full SVG features** — Gradients, effects, etc.
+- **Standalone** — No external resources
+
+### Limitations
+
+- **Large file size** — XML overhead
+- **Limited support** — Not all browsers
+
+## Guides
+
+- [COLR/CPAL](/guide/color-fonts/colr-cpal) — Vector layered color fonts
+- [Bitmaps](/guide/color-fonts/bitmaps) — sbix and CBDT/CBLC
+- [SVG Color](/guide/color-fonts/svg) — SVG-based color fonts
+
+## Quick Start
+
+### Check for Color Tables
+
+```ruby
+font = Fontisan::FontLoader.load('font.ttf')
+
+if font.tables['COLR']
+  puts "COLR/CPAL color font"
+end
+
+if font.tables['sbix']
+  puts "sbix bitmap font"
+end
+
+if font.tables['CBDT']
+  puts "CBDT/CBLC bitmap font"
+end
+
+if font.tables['SVG']
+  puts "SVG color font"
+end
+```
+
+### Get Color Information
+
+```ruby
+colr = font.tables['COLR']
+cpal = font.tables['CPAL']
+
+if colr && cpal
+  # Get base glyphs (color emoji)
+  colr.base_glyphs.each do |glyph_id|
+    puts "Base glyph: #{glyph_id}"
+    puts "  Layers: #{colr.layers_for(glyph_id).length}"
+
+    colr.layers_for(glyph_id).each do |layer|
+      color = cpal.color(layer[:palette_index])
+      puts "    Layer #{layer[:glyph_id]}: #{color}"
+    end
+  end
+end
+```

data/docs/guide/color-fonts/svg.md

@@ -0,0 +1,154 @@
+---
+title: SVG Color Fonts
+---
+
+# SVG Color Fonts
+
+SVG color fonts embed complete SVG documents for each glyph.
+
+## Overview
+
+SVG color fonts contain:
+- Full SVG documents with shapes, gradients, effects
+- Can be extremely detailed and complex
+- Self-contained (no external resources)
+
+## Structure
+
+```ruby
+svg = font.tables['SVG']
+
+# SVG documents by glyph ID
+svg.documents.each do |glyph_id, doc|
+  puts "Glyph #{glyph_id}:"
+  puts doc  # Complete SVG XML
+end
+```
+
+## Reading SVG Fonts
+
+### List SVG Glyphs
+
+```ruby
+font = Fontisan::FontLoader.load('svg-font.ttf')
+svg = font.tables['SVG']
+
+if svg
+  svg.documents.each do |glyph_id, doc|
+    glyph_name = font.glyph_name(glyph_id)
+    puts "#{glyph_name}: #{doc.length} bytes"
+  end
+end
+```
+
+### Parse SVG Content
+
+```ruby
+require 'nokogiri'
+
+svg = font.tables['SVG']
+doc = svg.documents[42]  # SVG for glyph 42
+
+parsed = Nokogiri::XML(doc)
+
+# Find elements
+paths = parsed.css('path')
+puts "Paths: #{paths.length}"
+
+rects = parsed.css('rect')
+puts "Rectangles: #{rects.length}"
+
+# Find gradients
+gradients = parsed.css('linearGradient', 'radialGradient')
+puts "Gradients: #{gradients.length}"
+```
+
+## SVG Features
+
+SVG fonts can include:
+
+| Feature | Support |
+|---------|---------|
+| Paths | ✓ |
+| Basic shapes | ✓ |
+| Gradients | ✓ |
+| Patterns | ✓ |
+| Clip paths | ✓ |
+| Masks | ✓ |
+| Filters | Limited |
+| Animations | No |
+| Scripts | No |
+
+## Exporting
+
+### Export SVG Files
+
+```ruby
+font = Fontisan::FontLoader.load('svg-font.ttf')
+svg = font.tables['SVG']
+
+Dir.mkdir('svg-glyphs') unless Dir.exist?('svg-glyphs')
+
+svg.documents.each do |glyph_id, doc|
+  glyph_name = font.glyph_name(glyph_id) || "glyph-#{glyph_id}"
+  filename = "svg-glyphs/#{glyph_name}.svg"
+  File.write(filename, doc)
+end
+```
+
+## Conversion
+
+### SVG to Other Formats
+
+```bash
+# SVG is preserved during conversion
+fontisan convert svg-font.ttf --to otf --output svg-font.otf
+```
+
+### Remove SVG
+
+```bash
+# Create version without SVG
+fontisan convert svg-font.ttf --to ttf --no-svg --output no-svg.ttf
+```
+
+## Limitations
+
+### File Size
+
+SVG fonts can be very large:
+- XML text overhead
+- Duplicate content across glyphs
+- Embedded gradients and filters
+
+### Browser Support
+
+| Browser | Support |
+|---------|---------|
+| Firefox | Full |
+| Safari | Full |
+| Chrome | Full (since v98) |
+| Edge | Full |
+
+### Performance
+
+- **Parsing** — SVG requires XML parsing
+- **Rendering** — Complex effects are slow
+- **Memory** — Large documents use more memory
+
+## Comparison with COLR/CPAL
+
+| Feature | SVG | COLR/CPAL |
+|---------|-----|-----------|
+| File size | Large | Small |
+| Effects | Full | Limited |
+| Gradients | Full | Limited |
+| Browser support | Good | Good |
+| Variable fonts | No | Yes |
+
+## Best Practices
+
+1. **Optimize SVGs** — Minimize file size
+2. **Use COLR/CPAL if possible** — Better performance
+3. **Test rendering** — Complex effects may not work everywhere
+4. **Provide fallbacks** — Not all platforms support SVG fonts

data/docs/guide/color.md

@@ -0,0 +1,51 @@
+# Color Fonts
+
+Fontisan supports working with color fonts in various formats.
+
+## Supported Formats
+
+- **COLR/CPAL** - OpenType color font tables
+- **SVG** - SVG-based color fonts
+- **CBDT/CBLC** - Color bitmap fonts
+
+## Reading Color Fonts
+
+```ruby
+require 'fontisan'
+
+# Load a color font
+font = Fontisan.load('color-font.ttf')
+
+# Check if font has color
+if font.color?
+  puts "This is a color font"
+  puts "Format: #{font.color_format}"
+end
+```
+
+## Color Palettes
+
+For COLR/CPAL fonts:
+
+```ruby
+# Get color palettes
+palettes = font.color_palettes
+
+palettes.each do |palette|
+  puts "Palette:"
+  palette.colors.each do |color|
+    puts "  ##{color.hex}"
+  end
+end
+```
+
+## Converting Color Fonts
+
+```ruby
+# Convert color font to WOFF2
+Fontisan.convert('color-font.ttf', output_format: :woff2)
+```
+
+## Related
+
+- [Variable Fonts](/guide/variable) - Variable font support