latex-project-template 0.0.3 → 0.0.4

data/README.md

@@ -20,11 +20,11 @@ the project directory is managed by git.
 
 latex-project-template depends on the following gems.
 
-- git
-- filename
-- user_config
+- [git](http://rubygems.org/gems/git)
+- [filename](http://rubygems.org/gems/filename)
+- [user_config](http://rubygems.org/gems/user_config)
 
-## Install
+## Installation
 
 We can install by rubygems.
 
@@ -38,7 +38,7 @@ First of all, we create configuration directory ~/.latex\_project\_template.
     latex-project-template --init
 
 Next, we edit template files in ~/.latex\_project\_template.
-If we want to create latex project 'new_project' fromo 'default' template, type
+If we want to create latex project 'new_project' from 'default' template, type
 
     latex-project-template new_project
 
@@ -51,17 +51,74 @@ To list templates in ~/.latex\_project\_template, we type
 
     latex-project-template --list
 
-## Special notations of template file names
+## Structure of template
+
+In ~/.latex\_project\_template there are the following directories.
+
+- template
+- component
+- variable
+- .git
+
+### 'template' directory
+
+'template' directory includes main files of templates.
+A template is a directory in 'template' directory and
+all files are fundamentally copied to a project directory.
+We can write template files with format simple texts or eruby files.
+
+If we want to create dynamically files then we use eruby.
+Files with the extension '.erb' is an eruby template and
+latex-project-template evaluates them when copying a template as a specified project.
+
+#### Special notations of template file names
+
+Some special notations of template file names also are used.
+The following strings starting \_\_ and ending \_\_ have special meanings.
 
 \_\_IMPORT\_\_
 : In \_\_IMPORT\_\_ we write list of files to import from other template.
+
 \_\_PROJECT\_\_
 : Replace \_\_PROJECT\_\_ by name of project.
+
 \_\_DOT\_\_
 : Replace \_\_DOT\_\_ by '.'.
+
 \_\_IGNORE\_\_
 : Files including \_\_IGNORE\_\_ are ignored.
 
+### 'component' directory
+
+Common parts of template files are placed in 'component' directory.
+In order to import into eruby templates, we use 'component' method.
+If there is 'component/rakefile_common.erb',
+we can use this file in eruby template.
+
+    <%= component('rakefile_common.erb') %>    
+
+### 'variable' directory
+
+The 'variable' directory has yaml files,
+which are used in eruby template.
+We can get the object of 'filename.yaml',
+referring to 'filename';
+
+For example, if there is variable/profile.yaml' like
+
+    ---
+    :name: Your Name
+
+then we can refer to the above value as in 'template/default/\_\_PROJECT\_\_.tex.erb'
+
+    <%= profile[:name] %>
+
+## Rake tasks
+
+Tasks to compile latex files with latexmk are defined in 'latex\_project\_template/task.rb'.
+To investigate usage of the file,
+we can see Rakefile in 'default' template.
+
 ## Contributing to latex-project-template
  
 - Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/bin/latex-project-template

@@ -10,7 +10,7 @@ Usage: #{File.basename(__FILE__)} project [template]
 
 HELP
 
-Version = '0.0.3'
+Version = '0.0.4'
 
 options = {
   :mode => :create

data/initial_files/template/default/__PROJECT__.tex.erb

@@ -2,6 +2,7 @@
 
 <%= component('math_preamble.tex') %>
 
+\title{}
 \author{<%= profile[:name] %>}
 \date{}
 

data/initial_files/template/japanese/__PROJECT__.tex.erb

@@ -2,6 +2,7 @@
 
 <%= component('math_preamble.tex') %>
 
+\title{}
 \author{<%= profile[:name] %>}
 \date{}
 

data/latex-project-template.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{latex-project-template}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Takayuki YAMAGUCHI"]

metadata

@@ -2,7 +2,7 @@
 name: latex-project-template
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Takayuki YAMAGUCHI
@@ -171,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -691823316385091189
+      hash: -161505429239603935
       segments: 
       - 0
       version: "0"