texstyles 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9025e4823886d88868c345453223241c4efdf271
-  data.tar.gz: 56cfe60c20c149d388370b36999165357e372a01
+  metadata.gz: 9be62b7996c31c41165d3e4ac1fa877db9e27077
+  data.tar.gz: b10580e3752e659673d865c338320c5c0c3ef7aa
 SHA512:
-  metadata.gz: 0f6fa85b6a4ed09dd8be11dce387085855f8fec712a4e18e9553c2ad155c18dcb17a35bb0c9deabaedb74fb0582104ed11905b913c5babd950d87ffd51819459
-  data.tar.gz: bac35af4bf71ca82fd4fdba12bfdf25ad686ca73ca43031d688968ecea255d459e4d4f5e6cd5b5afd3269857744c6c39e41f247ae753373a5a4685fcd5575670
+  metadata.gz: 976a16446b9b3225285af8e6bf424de453846e47bae5caa1ef1607388f9acbdd828c6af20d36a312732fef267cc1fb1387f5b6a6f7f81b499ed2b639aa8e1a37
+  data.tar.gz: b4d5341fe591d4e65a172ec95a2d6be6fc71adf67b4d374d66ae746727eaeca11fdcc4daf58101a8214fe6feaf41540eda6ef4a121bd9e08f06989a0195a538b

data/README.md

@@ -1,6 +1,6 @@
 # TeX Styles
 
-A collection of ERB-based TeX/LaTeX preamble styles, for the world of scholarly writing and beyond. Founded and maintained by the [Authorea](www.authorea.com) team.
+A collection of ERB-based TeX/LaTeX preamble styles, for the world of scholarly writing and beyond. Founded and maintained by the [Authorea](http://www.authorea.com) team.
 
 **CAUTION: This repository is in a pre-alpha dev sprint, consider it completely unstable until a 0.1.0 release**
 
@@ -8,6 +8,50 @@ A collection of ERB-based TeX/LaTeX preamble styles, for the world of scholarly
 [![license](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/authorea/texstyles/master/LICENSE)
 [![Gem Version](https://badge.fury.io/rb/texstyles.svg)](https://badge.fury.io/rb/texstyles)
 
+## Common Questions
+
+**Does this repository compete with [CTAN](http://www.ctan.org)?** No, to the contrary. It builds on top of the CTAN wealth of LaTeX packages, and some custom publisher-provided ones, to assemble styling templates that fully conform to specific sets of submission guidelines. The original use case has been submissions of scholarly articles, but we welcome extensions to theses, homeworks, quizzes, exercise sets, etc.
+
+**Why the choice of Ruby and ERB?** We wanted to optimize for simplicity and reusability, so we avoided more tool-focused templating solutions, such as Pandoc templates, or more elaborate XML-based solutions common to publishers.
+
+**What is the Goal?** Anyone should be able to grab this repository, write down a tiny metadata file, split out the header and main body of their LaTeX document and then have it typeset in but a few lines of Ruby ([example](https://github.com/Authorea/texstyles/blob/master/example/example_stylize.rb)). We developed this component for our Authorea exporter and are happy to contribute it back to the community and develop it jointly from here on out.
+
+**Wait, it's not so simple, how about...** This repository collects and refines an ever-growing dataset of stylistic templates for LaTeX documents. As such, it currently focuses entirely on document frontmatter/preamble information, and misses out on a long list of additional concerns, for example:
+  * citation styles, and going beyond LaTeX citations (via CSL)
+  * internationalization
+  * conflict-free use of a default set of packages
+
+To address these issues we have also released the [texstylist](https://github.com/Authorea/texstylist) Ruby gem, which is almost always the preferable entry point, as the texstyles library is included in it and a higher-level API is provided.
+
+## Usage
+
+```ruby
+require 'texstyles'
+
+header = '% Header goes here'
+abstract = '% Abstract goes here'
+
+metadata = {
+  'title' => 'An example scholarly article',
+  # ... full range of scholarly metadata omitted for space
+  'header' => header,
+  'abstract' => abstract
+}
+
+# Choose any available Texstyles::Style here
+# Full list can be fetched via: Texstyles::Style.list
+authorea_style = Texstyles::Style.new(:authorea)
+
+# To obtain the correct latex preamble for the given style:
+stylized_preamble = authorea_style.stylize_metadata(metadata)
+
+# Then piece together a document by hand (or use the texstylist gem for further automation)
+stylized_document = stylized_preamble + "a basic example\n"  + "\\end{document}"
+
+# Enjoy!
+```
+
+You can see a full example [here](https://github.com/Authorea/texstyles/blob/master/example/example_stylize.rb)
 
 ## Installation
 
@@ -25,11 +69,19 @@ Or install it yourself as:
 
     $ gem install texstyles
 
-## Usage
+## Roadmap
 
-## Contributing
+### Supported
+ * 100+ and growing scholarly export styles
+ * Core metadata items of scholarly articles
+ * White/blacklisting LaTeX style and class conflicts
+ * Independent citation style specifications
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Authorea/texstyles.
+### Upcoming
+ * Postamble support: Certain styles use a \begin{env}\end{env} wrapper around the entire article body, see e.g. a0poster
+ * Support for the full range of scholarly metadata. Need: \keywords, thesis metadata, journal metadata
+ * Decide on and use a standardized scholarly metadata language as input, instead of our custom YML dialect. Suggestions welcome!
+ * Gradually improve all export styles to fit the improved metadata scheme.
 
 ## License
 

data/example/example_stylize.rb

@@ -0,0 +1,37 @@
+require 'texstyles'
+
+header = '% Header goes here'
+abstract = '% Abstract goes here'
+
+metadata = {
+  'title' => 'An example scholarly article',
+  'short_title' => 'Example article',
+  'authors' => [
+  { 'name' => 'First Author',
+    'affiliation' => 1},
+  { 'name' => 'Second Author',
+    'affiliation' => 2},
+  { 'name' => 'Third Author',
+    'affiliations' => [1, 2]}
+  ],
+  'affiliations' => {
+    1 => 'Example Organization',
+    2 => 'Another Organization'
+  },
+  'header' => header,
+  'abstract' => abstract
+}
+
+
+# Choose any available Texstyles::Style here
+# Full list can be fetched via: Texstyles::Style.list
+authorea_style = Texstyles::Style.new(:authorea)
+
+# To obtain the correct latex preamble for the given style:
+stylized_preamble = authorea_style.stylize_metadata(metadata)
+
+# Then piece together a document by hand (or use the texstylist gem for further automation)
+stylized_document = stylized_preamble + "a basic example\n"  + "\\end{document}"
+
+# Enjoy!
+puts stylized_document

data/lib/texstyles.rb

@@ -8,7 +8,7 @@ module Texstyles
     end
 
     def list
-      Dir.glob(File.join(@@root, 'styles', "*.tex.erb")).map{|path| File.basename(path,'.tex.erb')}
+      Dir.glob(File.join(@@root, 'styles', "*.tex.erb")).map{|path| File.basename(path,'.tex.erb')}.sort
     end
 
     def categories

data/lib/texstyles/style.rb

@@ -28,7 +28,7 @@ module Texstyles
       @none_compatible = (@all_rule == false)
     end
 
-    def render_latex(options = {})
+    def stylize_metadata(options = {})
       @default_packages = options["default_packages"].to_s
       @header = options["header"].to_s
       @alternative_author_string = options["alternative_author_string"].to_s

data/styles/authorea-double-numbered.tex.erb

@@ -4,6 +4,7 @@
 \usepackage{setspace}
 \usepackage{titlesec}
 \usepackage{lineno}
+\usepackage{graphicx}
 \usepackage{xcolor}
 \usepackage[colorlinks = true,
             linkcolor = blue,

data/styles/authorea-double.tex.erb

@@ -3,6 +3,7 @@
 \usepackage{parskip}
 \usepackage{setspace}
 \usepackage{titlesec}
+\usepackage{graphicx}
 \usepackage{xcolor}
 \usepackage[colorlinks = true,
             linkcolor = blue,

data/styles/authorea-numbered.tex.erb

@@ -2,6 +2,7 @@
 \usepackage{fullpage}
 \usepackage{parskip}
 \usepackage{titlesec}
+\usepackage{graphicx}
 \usepackage{xcolor}
 \usepackage{lineno}
 \usepackage[colorlinks = true,

data/styles/authorea.tex.erb

@@ -2,6 +2,7 @@
 \usepackage{fullpage}
 \usepackage{parskip}
 \usepackage{titlesec}
+\usepackage{graphicx}
 \usepackage{xcolor}
 \usepackage[colorlinks = true,
             linkcolor = blue,

data/styles/epjc.tex.erb

@@ -51,18 +51,21 @@
 <% if !@alternative_author_string.to_s.empty? %>
  <%= @alternative_author_string %>
 <% else %>
-\author{<%=@first_author%>\thanksref{1}
-<% if !@coauthor_list.to_a.empty? %><% for i in (0..@coauthor_list.length-1) %>
-\and <%=@coauthor_list[i]%>\thanksref{<%=i+2%>}<% end %><% end %>}
+\author{<%=@first_author%>\thanksref{1}%
+%<% @coauthor_list.each_with_index do |item, index| %>
+\and <%=item%>\thanksref{<%=index+2%>}
+%<% end %>
+}
 
 \institute{<%=@first_affiliation%>\label{1}
-<% if !@coauthor_list.to_a.empty? %><% for i in (0..@coauthor_list.length-1) %>
-\and <%=@coauthor_affiliations[i]%>\label{<%=i+2%>}
-<% end %><% end %>}
+<% @coauthor_affiliations.each_with_index do |item, index| %>
+\and <%=item%>\label{<%=index+2%>}
+<% end %>
+}
 <% end %>
 
 
-\date{Received: date / Accepted: date}
+% \date{Received: date / Accepted: date}
 % The correct dates will be entered by the editor
 
 

data/styles/g3.tex.erb

@@ -40,8 +40,15 @@
 
 \correspondingauthor{Corresponding Author}
 
-<%= @abstract_begin_end %>
+<% if !@abstract_begin_end.empty? %>
+  <%= @abstract_begin_end %>
+<% else %>
+% An abstract is a requirement for the g3 template
+\begin{abstract}\end{abstract}
+<% end %>
+
 
+\keywords{} % keywords are also required
 \setboolean{displaycopyright}{true}
 
 \begin{document}

data/styles/report.tex.erb

@@ -15,3 +15,5 @@
 
 \begin{document}
 \maketitle
+
+<%= @abstract_begin_end %>

data/texstyles.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "texstyles"
-  spec.version       = "0.0.7"
+  spec.version       = "0.0.8"
 
   spec.authors       = ["Deyan Ginev"]
   spec.email         = ["deyan@authorea.com"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: texstyles
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Deyan Ginev
@@ -108,6 +108,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/example_stylize.rb
 - lib/texstyles.rb
 - lib/texstyles/style.rb
 - meta/a0poster-landscape.yml