docfu 0.0.3 → 0.0.5

data/Gemfile

@@ -1,17 +1,17 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
-gem "mixlib-cli", "~> 1.2.2"
+gem "mixlib-cli", "~> 1.3.0"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.8.0"
-  gem "yard", "~> 0.7"
+  gem "rspec", "~> 2.13.0"
+  gem "yard", "~> 0.8.6.1"
   gem "cucumber", ">= 0"
-  gem "bundler", "~> 1.1.3"
-  gem "jeweler", "~> 1.8.3"
-  gem (RUBY_VERSION =~ /^1\.9/ ? "simplecov" : "rcov"), ">= 0"
+  gem "bundler", "~> 1.3.5"
+  gem "jeweler", :git => "https://github.com/aia/jeweler.git", :branch => 'simplecov'
+  gem (RUBY_VERSION.gsub('.', '').to_i >= 190 ? "simplecov" : "rcov"), ">= 0"
 end

data/README.md

@@ -2,6 +2,14 @@
 
 A document generation utility. The intention is to make writing documentation // books less lame.
 
+## Installation
+
+On centos the following libraries need be installed:
+
+    texlive-latex texlive-xetex liberation pandoc
+    liberation-fonts-mono-fonts liberation-fonts-serif-fonts
+    liberation-fonts-common
+
 ## Contributing to docfu
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
@@ -12,6 +20,12 @@ A document generation utility. The intention is to make writing documentation //
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+## Special Thanks
+
+This library was heavily based from (with permission) the skeleton that Scott Chacon used for the book Pro Git.
+
+If you haven't checked it out, you should pick up a [copy](http://www.amazon.com/Pro-Git-Scott-Chacon/dp/1430218339)!
+
 ## Copyright
 
 Copyright (c) 2012 Josh Toft. See LICENSE.txt for

data/lib/docfu.rb

@@ -7,7 +7,7 @@ require 'mixlib/cli'
 
 # Document like a ninja
 module Docfu
-  VERSION = '0.0.3'
+  VERSION = '0.0.5'
 end
 
 require 'docfu/outputs'

data/lib/docfu/files/config.yml

@@ -1,7 +1,7 @@
 default:
-  font: Liberation Serif
+  font: Helvetica
   bold: "{* Bold}"
-  mono: Liberation Mono
+  mono: Andale Mono
   prechap: "Chapter "
   postchap: ""
   presect: "Section "
@@ -12,7 +12,6 @@ default:
   fig: "Figure "
   tab: "Table "
   indent: "\\qquad"
-  thanks: ""
 zh:
   langrule: "\\XeTeXlinebreakskip=0em plus 0.1em minus 0.01em\n\\XeTeXlinebreakpenalty=0"
   font: AR PL UMing CN
@@ -68,6 +67,7 @@ ru:
   tab: "Таблица "
   dql: "«"
   dqr: "»"
+  langrule: "\\frenchspacing"
 cs:
   prechap: "Kapitola "
   presect: "Oddíl "
@@ -78,15 +78,20 @@ cs:
 fr:
   prechap: "Chapitre "
   presect: "Section "
-  fig: "Figure "
+  fig: "figure "
   tab: "Tableau "
   font: Linux Libertine
   mono: Courier New
   con: "Table des matières"
   langrule: "\\frenchspacing\\usepackage{fontspec}\n\\fontspec[Ligatures={Common}]{Linux Libertine}\n"
-  thanks: ""
   dql: "«\\,"
   dqr: "\\,»"
+es:
+  prechap: "Capítulo "
+  presect: "Sección "
+  fig: "Figura "
+  tab: "Tabla "
+  con: "Contenidos "  
 mk:
   fig: "Слика"
   con: "Содржина"
@@ -95,19 +100,23 @@ mk:
   dql: "„"
   dqr: "“"
   tab: "Табела"
+no-nb:
+  dql: "«"
+  dqr: "»"
 de:
   langrule: "\\frenchspacing"
   dql: "„"
   dqr: "“"
 ko:
   langrule: "\\XeTeXlinebreakskip=0em plus 0.1em minus 0.01em\n\\XeTeXlinebreakpenalty=0"
-  font: UnBatang
-  bold: UnGraphic
-  mono: UnDotum
+  font: NanumMyeongjo
+  bold: "{* Bold}"
+  mono: NanumGothicCoding 
   prechap: ""
   postchap: "장"
   presect: ""
   postsect: "절"
+  indent: " "
   con: "목차"
   fig: "그림"
   tab: "표"

data/lib/docfu/outputs/pdf.rb

@@ -96,11 +96,28 @@ module Docfu
     def pre_pandoc(string, cfg)
       replace(string) do
         # Pandoc discards #### subsubsections #### - this hack recovers them
+        s(/\#\#\#\#\# (.*?) \#\#\#\#\#/, 'PARAGRAPH: \1')
         s(/\#\#\#\# (.*?) \#\#\#\#/, 'SUBSUBSECTION: \1')
 
         # Turns URLs into clickable links
-        s(/\`(http:\/\/[A-Za-z0-9\/\%\&\=\-\_\\\.]+)\`/, '<\1>')
-        s(/(\n\n)\t(http:\/\/[A-Za-z0-9\/\%\&\=\-\_\\\.]+)\n([^\t]|\t\n)/, '\1<\2>\1')
+        s(/\`(http:\/\/[A-Za-z0-9\/\%\&\=\-\_\\\.\(\)\#]+)\`/, '<\1>')
+        s(/(\n\n)\t(http:\/\/[A-Za-z0-9\/\%\&\=\-\_\\\.\(\)\#]+)\n([^\t]|\t\n)/, '\1<\2>\1')
+
+        # Match table in markdown and change them to pandoc's markdown tables
+        s(/(\n(\n\t([^\t\n]+)\t([^\t\n]+))+\n\n)/) do
+          first_col=20
+          t = $1.gsub(/(\n?)\n\t([^\t\n]+)\t([^\t\n]+)/) do
+            if $1=="\n"
+              # This is the header, need to add the dash line
+              $1 << "\n " << $2 << " "*(first_col-$2.length) << $3 <<
+              "\n " << "-"*18 << "  " << "-"*$3.length
+            else
+              # Table row : format the first column as typewriter and align
+              $1 << "\n `" << $2 << "`" + " "*(first_col-$2.length-2) << $3
+            end
+          end
+          t << "\n"
+        end
 
         # Process figures
         s(/Insert\s18333fig\d+\.png\s*\n.*?\d{1,2}-\d{1,2}\. (.*)/, 'FIG: \1')
@@ -117,15 +134,15 @@ module Docfu
         s(/SUBSUBSECTION: (.*)/, '\subsubsection{\1}')
 
         # Enable proper cross-reference
-        s(/#{cfg['fig'].gsub(space, '\s')}\s*(\d+)\-\-(\d+)/, '\imgref{\1.\2}')
-        s(/#{cfg['tab'].gsub(space, '\s')}\s*(\d+)\-\-(\d+)/, '\tabref{\1.\2}')
-        s(/#{cfg['prechap'].gsub(space, '\s')}\s*(\d+)(\s*)#{cfg['postchap'].gsub(space, '\s')}/, '\chapref{\1}\2')
+        s(/#{config['fig'].gsub(space, '\s')}\s*(\d+)\-\-(\d+)/, '\imgref{\1.\2}')
+        s(/#{config['tab'].gsub(space, '\s')}\s*(\d+)\-\-(\d+)/, '\tabref{\1.\2}')
+        s(/#{config['prechap'].gsub(space, '\s')}\s*(\d+)(\s*)#{config['postchap'].gsub(space, '\s')}/, '\chapref{\1}\2')
 
         # Miscellaneous fixes
         s(/FIG: (.*)/, '\img{\1}')
         s('\begin{enumerate}[1.]', '\begin{enumerate}')
         s(/(\w)--(\w)/, '\1-\2')
-        s(/``(.*?)''/, "#{cfg['dql']}\\1#{cfg['dqr']}")
+        s(/``(.*?)''/, "#{config['dql']}\\1#{config['dqr']}")
 
         # Typeset the maths in the book with TeX
         s('\verb!p = (n(n-1)/2) * (1/2^160))!', '$p = \frac{n(n-1)}{2} \times \frac{1}{2^{160}}$)')
@@ -133,16 +150,20 @@ module Docfu
         s(/\sx\s10\\\^\{\}(\d+)/, '\e{\1}')
 
         # Convert inline-verbatims into \texttt (which is able to wrap)
-        s(/\\verb(\W)(.*?)\1/) do
-          "{\\texttt{#{verbatim_sanitize($2)}}}"
-        end
+        s(/\\verb(\W)(.*?)\1/ ,'\\texttt{\2}')
+        # s(/\\verb(\W)(.*?)\1/) do
+        #   "{\\texttt{#{verbatim_sanitize($2)}}}"
+        # end
 
-        # Ensure monospaced stuff is in a smaller font
-        s(/(\\verb(\W).*?\2)/, '{\footnotesize\1}')
-        s(/(\\begin\{verbatim\}.*?\\end\{verbatim\})/m, '{\footnotesize\1}')
+        # Style Tables
+        s(/ctable\[pos = H, center, botcap\]\{..\}/ , 'ctable[pos = ht!, caption = ~ ,width = 130mm, center, botcap]{lX}')
 
         # Shaded verbatim block
         s(/(\\begin\{verbatim\}.*?\\end\{verbatim\})/m, '\begin{shaded}\1\end{shaded}')
+
+        # Ensure monospaced stuff is in a smaller font
+        # s(/(\\verb(\W).*?\2)/, '{\footnotesize\1}')
+        # s(/(\\begin\{verbatim\}.*?\\end\{verbatim\})/m, '{\footnotesize\1}')
       end
     end
     

data/lib/docfu/templates/book.tex

@@ -13,18 +13,20 @@
 \usepackage{booktabs}
 \usepackage{indentfirst}
 \usepackage{framed,color}
-\usepackage{array}
-\usepackage[font=small,format=plain,labelfont=bf,up,textfont=it,up]{caption}
+\usepackage{caption}
+\captionsetup{font=bf,position=below}
+
+\usepackage{ctable}
 
 \definecolor{shadecolor}{gray}{0.90}
 
-\setromanfont[Mapping=tex-text,BoldFont=<%= cfg['bold'] %>]{<%= cfg['font'] %>}
-\setmonofont{<%= cfg['mono'] %>}
+\setromanfont[Mapping=tex-text,BoldFont=<%= config['bold'] %>]{<%= config['font'] %>}
+\setmonofont[Scale=.85]{<%= config['mono'] %>}
 
 \XeTeXlinebreaklocale{<%= lang %>}
-<%= cfg['langrule'] %>
+<%= config['langrule'] %>
 
-\settowidth{\parindent}{<%= cfg['indent'] %>}
+\settowidth{\parindent}{<%= config['indent'] %>}
 
 \title{<%= info['title'] %>}
 \author{<%= info['author'] %>}
@@ -38,13 +40,11 @@
 \makeatother
 
 \title{\textbf{\savedtitle}}
-\author{\textbf{\savedauthor}\thanks{<%= cfg['thanks'] %>}}
+\author{\textbf{\savedauthor}\thanks{<%= config['thanks'] %>}}
 \def\w3cdtfymd{\the\year-\ifnum\month<10 0\fi\the\month-\ifnum\day<10 0\fi\the\day}
 \date{\w3cdtfymd}
 \renewcommand{\thefootnote}{\fnsymbol{footnote}}
 
-\newcommand{\PreserveBackslash}[1]{\let\temp=\\#1\let\\=\temp}
-\let\PBS=\PreserveBackslash
 \makeatletter
   \setlength\headheight{12\p@}
   \setlength\headsep   {.25in}
@@ -90,30 +90,31 @@
 
 \newcounter{img}[chapter]
 \renewcommand{\theimg}{\thechapter.\arabic{img}}
-\newcommand{\img}[1]{\begin{figure}[h!]
-	\refstepcounter{img}
-	\label{img:\theimg}
-	\centering\includegraphics[width=\maxwidth]{figures/\theimg.png}
-	\caption{#1}
+\newcommand{\img}[1]{\begin{figure}[ht!]
+  \refstepcounter{img}
+  \label{img:\theimg}
+  \centering\IfFileExists{figures/\theimg.pdf}{\includegraphics[width=\maxwidth]{figures/\theimg.pdf}}{\includegraphics[width=\maxwidth]{figures/\theimg.png}}
+
+  \caption{#1}
 \end{figure}}
 
 \newcounter{tab}[chapter]
 \renewcommand{\thetab}{\thechapter.\arabic{tab}}
 
-\newcommand{\prechap}{<%= cfg['prechap'] %>}
-\newcommand{\postchap}{<%= cfg['postchap'] %>}
-\newcommand{\presect}{<%= cfg['presect'] %>}
-\newcommand{\postsect}{<%= cfg['postsect'] %>}
+\newcommand{\prechap}{<%= config['prechap'] %>}
+\newcommand{\postchap}{<%= config['postchap'] %>}
+\newcommand{\presect}{<%= config['presect'] %>}
+\newcommand{\postsect}{<%= config['postsect'] %>}
 \renewcommand{\chaptermark}[1]{\markboth{\textbf{\prechap \thechapter \postchap}\hspace*{1ex}#1}{}}
 \renewcommand{\sectionmark}[1]{\markright{\textbf{\presect \thesection \postsect}\hspace*{1ex}#1}}
 \newcommand{\chap}[1]{\newpage\thispagestyle{empty}\chapter{#1}\label{chap:\thechapter}}
 \newcommand{\chapref}[1]{\hyperref[chap:#1]{\prechap #1\postchap}}
-\newcommand{\imgref}[1]{\hyperref[img:#1]{<%= cfg['fig'] %>#1}}
-\newcommand{\tabref}[1]{\hyperref[tab:#1]{<%= cfg['tab'] %>#1}}
+\newcommand{\imgref}[1]{\hyperref[img:#1]{<%= config['fig'] %>#1}}
+\newcommand{\tabref}[1]{\hyperref[tab:#1]{<%= config['tab'] %>#1}}
 \newcommand{\e}[1]{$ \times 10^{#1}$}
-\renewcommand{\contentsname}{<%= cfg['con'] %>}
-\renewcommand{\figurename}{<%= cfg['fig'] %>}
-\renewcommand{\tablename}{<%= cfg['tab'] %>}
+\renewcommand{\contentsname}{<%= config['con'] %>}
+\renewcommand{\figurename}{<%= config['fig'] %>}
+\renewcommand{\tablename}{<%= config['tab'] %>}
 
 \makeatletter
 \def\@makechapterhead#1{%

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docfu
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2013-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.6.1
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,23 +90,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -170,9 +170,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -67242471902472211
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -181,8 +178,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Docs like a ninja
 test_files: []
+has_rdoc: