glyph 0.4.2 → 0.5.0

data/macros/filters.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 macro :textile do
 	exact_parameters 1
@@ -70,7 +71,7 @@ macro :markdown do
 	end
 end
 
-rewrite "textile_section", 
+define "textile_section", 
 %{section[
 		@src[{{src}}]
 		@id[{{id}}]
@@ -81,7 +82,7 @@ rewrite "textile_section",
 		]
 	]}
 
-rewrite "markdown_section", 
+define "markdown_section", 
 %{section[
 		@src[{{src}}]
 		@id[{{id}}]

data/macros/inline.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+macro :anchor do 
+	min_parameters 1
+	max_parameters 2
+	bookmark :id => param(0), :title => param(1), :file => @source_file
+	@data[:id] = param 0
+	@data[:title] = param 1
+	render
+end
+
+macro :link do
+	min_parameters 1
+	max_parameters 2
+	target = param 0 
+	title = param 1 
+	if target.match /^#/ then
+		@node[:document].links << target 
+		anchor = target.gsub /^#/, ''
+		bmk = bookmark? anchor
+		if !bmk then
+			placeholder do |document|
+				bmk = document.bookmark?(anchor)
+				macro_error "Bookmark '#{anchor}' does not exist" unless bmk
+				bmk_title = title
+				bmk_title = bmk.title if bmk_title.blank?
+				@data[:target] = bmk.link(@source_file)
+				@data[:title] = bmk_title
+				render
+			end
+		else
+			bmk_title = title
+			bmk_title = bmk.title if bmk_title.blank?
+			@data[:target] = bmk.link(@source_file)
+			@data[:title] = bmk_title
+			render
+		end
+	else
+		if Glyph['options.url_validation'] && !@node[:document].links.include?(target) then
+			begin
+				url = URI.parse(target.gsub(/\\\./, ''))
+			rescue Exception => e
+				macro_warning "Invalid URL: #{url||target}", e
+			end
+			response = Net::HTTP.get_response(url)
+			debug "Checking link URL: #{url} (#{response.code})"
+			if response.code.to_i > 302 then
+				macro_warning "Linked URL '#{url}' returned status #{response.code} (#{response.message})"
+			end
+		end
+		@node[:document].links << target 
+		title ||= target
+		@data[:target] = target
+		@data[:title] = title
+		render
+	end
+end
+
+macro :fmi do
+	exact_parameters 2, :level => :warning
+	topic = param 0
+	href = param 1
+	link = placeholder do |document| 
+		interpret "link[#{href}]"
+	end
+	@data[:topic] = topic
+	@data[:link] = link
+	render
+end
+
+macro :draftcomment do
+	if Glyph['document.draft'] then
+		@data[:comment] = value
+		render
+	else
+		""
+	end
+end
+
+macro :todo do
+	exact_parameters 1
+	todo = {:source => @source_name, :text => value}
+	@node[:document].todos << todo unless @node[:document].todos.include? todo
+	if Glyph['document.draft']  then
+		@data[:todo] = value
+		render
+	else
+		""
+	end
+end
+
+macro_alias :bookmark => :anchor
+macro_alias '#' => :anchor
+macro_alias '=>' => :link
+macro_alias '!' => :todo
+macro_alias :dc => :draftcomment

data/macros/reps/html.rb

@@ -0,0 +1,180 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# Inline
+
+rep :link do |data|
+	%{<a href="#{data[:target]}">#{data[:title]}</a>}
+end
+
+rep :anchor do |data|
+	%{<a id="#{data[:id]}">#{data[:title]}</a>}
+end
+
+rep :fmi do |data|
+	%{<span class="fmi">for more information on #{data[:topic]}, see #{data[:link]}</span>}
+end
+
+rep :draftcomment do |data|
+	%{<span class="comment"><span class="comment-pre"><strong>Comment:</strong> </span>#{data[:comment]}</span>}
+end
+
+rep :todo do |data|
+	%{<span class="todo"><span class="todo-pre"><strong>TODO:</strong> </span>#{data[:todo]}</span>} 
+end
+
+# Block
+
+rep :note do |data|
+	css_class = data[:name].to_s.match(/[a-z0-9_-]/i) ? data[:name] : "note"
+	%{<div class="#{css_class}">
+<span class="note-title">#{data[:name].to_s.capitalize}</span>#{data[:text]}
+
+</div>}
+end
+
+rep :box do |data|
+	%{<div class="box">
+<div class="box-title">#{data[:title]}</div>
+#{data[:text]}
+
+</div>}
+end
+
+rep :codeblock do |data|
+	%{
+<div class="code">
+<pre>
+<code>
+#{data[:text]}
+</code>
+</pre>
+</div>}
+end
+
+rep :image do |data|
+	interpret "img[@src[#{data[:src]}]#{data[:attrs].join}]"
+end
+
+rep :figure do |data|
+	interpret %{div[@class[figure]#{data[:attrs].join}\\/img[@src[#{data[:src]}]]div[@class[caption]#{data[:caption]}]]}
+end
+
+rep :title do |data|
+	%{<h1>
+	#{Glyph["document.title"]}
+</h1>}
+end
+
+rep :subtitle do |data|
+	%{<h2>
+	#{Glyph["document.subtitle"]}
+</h2>}
+end
+
+rep :author do |data|
+	%{<div class="author">
+by <em>#{Glyph["document.author"]}</em>
+</div>}
+end
+
+rep :pubdate do |data|
+	%{<div class="pubdate">
+#{data[:date]}
+</div>}
+end
+
+rep :revision do |data|
+	%{<div class="revision">#{Glyph['document.revision']}</div>}
+end
+
+rep :navigation do |data|
+	%{<div class="navigation">#{data[:previous]} | #{data[:contents]} | #{data[:next]}</div>}
+end
+
+# Structure
+
+rep :document do |data|
+	%{<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+#{data[:content]}
+
+</html>}
+end
+
+rep :meta do |data|
+ %{<meta name="#{data[:name]}" content="#{data[:content]}" />}
+end
+
+rep :head do |data|
+	%{<head>
+<title>#{Glyph["document.title"]}</title>
+#{data[:author]}
+#{data[:copyright]}
+<meta name="generator" content="Glyph v#{Glyph::VERSION} (http://www.h3rald.com/glyph)" />
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+#{data[:content]}
+</head>
+}
+end
+
+rep :style do |data|
+	file = data[:file]
+	case Glyph['document.styles'].to_s
+	when 'embed' then
+		style = ""
+		case file.extname
+		when ".css" then
+			style = file_load file
+		when ".sass", ".scss" then
+			begin
+				require 'sass'
+				style = Sass::Engine.new(file_load(file), :syntax => file.extname.gsub(/^\./, '').to_sym).render
+			rescue LoadError
+				macro_error "Sass is not installed. Please run: gem install sass"
+			rescue Exception
+				raise
+			end
+		else
+			macro_error "Extension '#{file.extname}' not supported."
+		end
+		%{<style type="text/css">
+			#{style}
+</style>}
+	when 'import' then
+		%{<style type="text/css">
+	@import url("#{Glyph["output.#{Glyph['document.output']}.base"]}styles/#{value.gsub(/\..+$/, '.css')}");
+</style>}
+	when 'link' then
+		%{<link href="#{Glyph["output.#{Glyph['document.output']}.base"]}styles/#{value.gsub(/\..+$/, '.css')}" rel="stylesheet" type="text/css" />}
+	else
+		macro_error "Value '#{Glyph['document.styles']}' not allowed for 'document.styles' setting"
+	end
+end
+
+rep :toc do |data|
+	%{<div class="contents">
+<h2 class="toc-header" id="#{data[:toc_id]}">#{data[:title]}</h2>
+<ol class="toc">
+						#{data[:descend_section].call(data[:document].structure, nil)}
+</ol>
+</div>}
+end
+
+rep :toc_item do |data|
+	"<li class=\"#{data[:classes].join(" ").strip}\">#{data[:title]}</li>"
+end
+
+rep :toc_sublist do |data|
+	"<li><ol>#{data[:contents]}</ol></li>\n"
+end
+
+rep :section do |data|
+	css_class = data[:name].to_s.match(/[a-z0-9_-]/i) ? data[:name] : "section"
+	title = data[:title] ? %{<h#{data[:level]} id="#{data[:id]}">#{data[:title]}</h#{data[:level]}>\n} : ""
+	%{<div class="#{css_class}">
+#{title}#{data[:content]}
+
+</div>}	
+end

data/macros/reps/html5.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+reps_for :html
+
+# Inline
+
+rep :fmi do |data|
+	%{<span class="fmi">for more information on <mark>#{data[:topic]}</mark>, see #{data[:link]}</span>}
+end
+
+rep :draftcomment do |data|
+	%{<aside class="comment"><span class="comment-pre"><strong>Comment:</strong> </span>#{data[:comment]}</aside>}
+end
+
+rep :todo do |data|
+	%{<aside class="todo"><span class="todo-pre"><strong>TODO:</strong> </span>#{data[:todo]}</aside>} 
+end
+
+# Block
+
+rep :note do |data|
+	css_class = data[:name].to_s.match(/[a-z0-9_-]/i) ? data[:name] : "note"
+	%{<aside class="#{css_class}">
+<span class="note-title">#{data[:name].to_s.capitalize}</span>#{data[:text]}
+
+</aside>}
+end
+
+rep :box do |data|
+	%{<aside class="box">
+<div class="box-title">#{data[:title]}</div>
+#{data[:text]}
+
+</aside>}
+end
+
+rep :figure do |data|
+	interpret %{xml/figure[#{data[:attrs].join}\\/xml/img[@src[#{data[:src]}]]xml/figcaption[#{data[:caption]}]]}
+end
+
+rep :title do |data|
+	%{<h1>
+	#{Glyph["document.title"]}
+</h1>}
+end
+
+rep :subtitle do |data|
+	%{<h2>
+	#{Glyph["document.subtitle"]}
+</h2>}
+end
+
+rep :author do |data|
+	%{<div class="author">
+by <em>#{Glyph["document.author"]}</em>
+</div>}
+end
+
+rep :pubdate do |data|
+	%{<time class="pubdate"  datetime="#{Time.now.strftime("%Y-%m-%d")}">
+#{data[:date]}
+</time>}
+end
+
+rep :revision do |data|
+	%{<div class="revision">#{Glyph['document.revision']}</div>}
+end
+
+rep :navigation do |data|
+	%{<nav class="navigation">#{data[:previous]} | #{data[:contents]} | #{data[:next]}</nav>}
+end
+
+# Structure
+
+rep :document do |data|
+	%{<!DOCTYPE html>
+<html lang="en">
+#{data[:content]}
+
+</html>}
+end
+
+rep :toc do |data|
+	%{<nav class="contents">
+<h1 class="toc-header" id="#{data[:toc_id]}">#{data[:title]}</h1>
+<ol class="toc">
+						#{data[:descend_section].call(data[:document].structure, nil)}
+</ol>
+</nav>}
+end
+
+rep :section do |data|
+	css_class = data[:name].to_s.match(/[a-z0-9_-]/i) ? data[:name] : "section"
+	title = data[:title] ? %{<header><h1 id="#{data[:id]}">#{data[:title]}</h1></header>\n} : ""
+	%{<section class="#{css_class}">
+#{title}#{data[:content]}
+
+</section>}	
+end

data/macros/reps/web.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+reps_for :html

data/macros/reps/web5.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+reps_for :html5

data/macros/structure.rb

@@ -0,0 +1,229 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+macro :section do 
+	max_parameters 1
+	if raw_attribute(:src) && Glyph.multiple_output_files? then
+		required_attribute :title
+	end
+	@data[:name] = @name
+	h = ""
+	if attr(:title) then
+		level = 1
+		@node.ascend do |n| 
+			break if n.respond_to?(:attribute) && n.attribute(:class) && n.attribute(:class).children.join.strip == "topic"
+			#if n.is_a?(Glyph::MacroNode) && Glyph["system.structure.headers"].include?(n[:name]) then
+			if n.is_a?(Glyph::MacroNode) && n[:name].in?(Glyph.titled_sections) then
+				level+=1
+			end
+		end
+		ident = (attr(:id) || "h_#{@node[:document].headers.length+1}").to_sym
+		# The bookmark is added when the section is first processed; therefore it will exist already when a topic layout is processed
+		bmk = @node[:document].bookmark?(ident)
+		bmk ||=  header	:title => attr(:title), 
+			:level => level, 
+			:id => ident, 
+			:toc => !attr(:notoc),
+			:definition => @source_file,
+			:file => (attr(:src) || @source_file)
+		@node[:header] = bmk
+		@data[:title] = attr :title
+		@data[:level] = level
+		@data[:id] = bmk.code
+	end
+	if attr(:src) then 
+		# Create topic
+		if Glyph.multiple_output_files? 
+			topic_id = (attr(:id) || "t_#{@node[:document].topics.length}").to_sym
+			layout = attr(:layout) || Glyph["output.#{Glyph['document.output']}.layouts.topic"] || :topic
+			layout_name = "layout/#{layout}".to_sym
+			macro_error "Layout '#{layout}' not found" unless Glyph::MACROS[layout_name]
+			result = interpret %{#{layout_name}[
+											@title[#{attr(:title)}]
+											@id[#{topic_id}]
+											@contents[include[@topic[true]#{attr(:src)}]]
+									]}
+									bmk = @node[:document].bookmark? topic_id
+									if bmk then
+										# Fix file for topic bookmark
+										@node[:document].bookmark?(topic_id).file = attr(:src)
+									else
+										bookmark :title => attr(:title), :id => topic_id, :file => attr(:src), :definition => @source_file
+									end
+									topic_src = attr(:src)
+									topic_src += ".glyph" unless topic_src.match /\..+$/
+										@node[:document].topics << {:src => topic_src, :title => attr(:title), :id => topic_id, :contents => result}
+									# Process section contents
+									@data[:content] = value
+		else
+			v = raw_value
+			@node.children.delete_if{|c| !c.is_a?(Glyph::AttributeNode)}
+			body = interpret "include[#{attr(:src)}]#{v}"
+			@data[:content] = body
+		end
+	else
+		@data[:content] = value
+	end
+	render
+end
+
+macro :article do
+	exact_parameters 1
+	head = raw_attr(:head)
+ 	head ||= %{style[default.css]}
+	pre_title = raw_attr(:"pre-title")
+	post_title = raw_attr(:"post-title")
+	pubdate = @node.attr(:pubdate) ? "pubdate[#{@node.attr(:pubdate).contents}]" : "pubdate[]"
+	halftitlepage = raw_attr(:halftitlepage)
+	halftitlepage ||= %{
+			#{pre_title}
+			title[]
+			subtitle[]
+			author[]
+			#{pubdate}
+			#{post_title}
+	}
+	interpret %{document[
+	head[#{head}]
+	body[
+		halftitlepage[
+			#{halftitlepage}
+		]
+		#{@node.value}
+	]
+]}	
+end
+
+macro :book do
+	no_parameters
+	head = raw_attr(:head) 
+	head ||= %{style[default.css]}
+	pre_title = raw_attr(:"pre-title")
+	post_title = raw_attr(:"post-title")
+	titlepage = raw_attr(:titlepage)
+	pubdate = @node.attr(:pubdate) ? "pubdate[#{@node.attr(:pubdate).contents}]" : "pubdate[]"
+	titlepage ||= %{
+			#{pre_title}
+			title[]
+			subtitle[]
+			revision[]
+			author[]
+			#{pubdate}
+			#{post_title}
+	}
+	frontmatter = raw_attr(:frontmatter)
+	bodymatter = raw_attr(:bodymatter)
+	backmatter = raw_attr(:backmatter)
+	frontmatter = "frontmatter[\n#{frontmatter}\n]" if frontmatter
+	bodymatter = "bodymatter[\n#{bodymatter}\n]" if bodymatter
+	backmatter = "backmatter[\n#{backmatter}\n]" if backmatter
+	interpret %{document[
+	head[#{head}]
+	body[
+		titlepage[
+			#{titlepage}
+		]
+		#{frontmatter}
+		#{bodymatter}
+		#{backmatter}
+	]
+]}	
+end
+
+
+macro :document do
+	exact_parameters 1
+	@data[:content] = value
+	render
+end
+
+macro :head do
+	exact_parameters 1
+	@data[:author] = Glyph['document.author'].blank? ? "" : render(:meta, :name => "author", :content => Glyph['document.author'])
+	@data[:copyright] = Glyph['document.author'].blank? ? "" : render(:meta, :name => "copyright", :content => Glyph['document.author'])
+	@data[:content] = value
+	render
+end
+
+macro :style do 
+	within :head
+	exact_parameters 1
+	file = Glyph.lite? ? Pathname.new(value) : Glyph::PROJECT/"styles/#{value}"
+	file = Pathname.new Glyph::HOME/'styles'/value unless file.exist?
+	macro_error "Stylesheet '#{value}' not found" unless file.exist?
+	@node[:document].style file
+	@data[:file] = file
+	render
+end
+
+macro :toc do 
+	if @node[:document].toc[:contents] then
+		@node[:document].toc[:contents] 
+	else
+		max_parameters 1
+		depth = param(0)
+		toc = placeholder do |document|
+			descend_section = lambda do |n1, added_headers|
+				list = ""
+				added_headers ||= []
+				n1.descend do |n2, level|
+				  if n2.is_a?(Glyph::MacroNode) && n2[:name].in?(Glyph.titled_sections) then
+						if Glyph.multiple_output_files? then
+							# Only consider topics/booklets when building TOC for web/web5
+							next if !n2.attribute(:src) && n2.child_macros.select{|child| child.attribute(:src)}.blank? 
+						end
+						next if n2.find_parent{|node| Glyph['system.structure.special'].include? node[:name] }
+						header_obj = n2[:header]
+						next if depth && header_obj && (header_obj.level-1 > depth.to_i) || header_obj && !header_obj.toc?
+						next if added_headers.include? header_obj
+						added_headers << header_obj
+						# Check if part of frontmatter, bodymatter or backmatter
+						container = n2.find_parent do |node| 
+							node.is_a?(Glyph::MacroNode) && 
+								node[:name].in?([:frontmatter, :bodymatter, :appendix, :backmatter])
+						end[:name] rescue nil
+						if header_obj then 
+							if (!Glyph.multiple_output_files? || (header_obj.definition != header_obj.file)) then
+								link_header = render(:link, :title => header_obj.title, :target => header_obj.link(@source_file))
+							else
+								link_header =	header_obj.title
+							end
+							list << render(:toc_item, :classes => [container, n2[:name]], :title => link_header) 
+						end
+						child_list = ""
+						n2.children.each do |c|
+							child_list << descend_section.call(c, added_headers)
+						end	
+						list << render(:toc_sublist, :contents => child_list) unless child_list.blank?
+					end
+				end
+				list
+			end
+			title ||= "Table of Contents"
+			bmk = @node[:document].bookmark?(:toc) || bookmark(:id => :toc, :file => @source_file, :title => title)
+			@data[:toc_id] = bmk.to_s
+			@data[:title] = bmk.title
+			@data[:document] = document
+			@data[:descend_section] = descend_section
+			render
+		end
+		@node[:document].toc[:contents] = toc.to_s
+		toc
+	end
+end
+
+# See:
+#  http://microformats.org/wiki/book-brainstorming
+#  http://en.wikipedia.org/wiki/Book_design
+
+(Glyph['system.structure.frontmatter'] + Glyph['system.structure.bodymatter'] + Glyph['system.structure.backmatter']).
+	each {|s| macro_alias s => :section }
+
+macro_alias "§" => :section
+macro_alias :frontcover => :section
+macro_alias :titlepage => :section
+macro_alias :halftitlepage => :section
+macro_alias :frontmatter => :section
+macro_alias :bodymatter => :section
+macro_alias :backmatter => :section
+macro_alias :backcover => :section