hackademic 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 285e9c888a7c5213b75349f3e32028f25e45b975
-  data.tar.gz: 50c1106a390b3f5266c0a9b8fe09dc2de79b2e53
+  metadata.gz: 81fc1f100c2c747a4d4a7f16b412bd0c680a590a
+  data.tar.gz: b78ea9ebf87962f99dcce90f3ec421fa503d1a0e
 SHA512:
-  metadata.gz: 5baa1bcfba0c3a5b2a48904ba59fdbdea2217cba612c197dfe0e5487641cd1acac6ecfd37b301c88c5f95c434f151b233a1e3a97c5e1039e7ffe3a7377f0b55b
-  data.tar.gz: ce47babd7e1a4601c14157dbeea66df08d959bdaee2d98c2f25dbaa5c12983e25871a1bea1e7a146d1a19c340d730befb48ff58249162ccb8f325f62d18eec78
+  metadata.gz: d1df2217f96a25d9e49f58c73a683e8c052e8ba791e8c14a7175fda0a6a7ee16b9436051af8cf305396c60a54bcbf7df6deb6dc0d32ff21020c96be3e186421f
+  data.tar.gz: 067106d24fa9a1a36a4f20103885703e08295123e3fa7651c510a49e73f9f9b12e57b4786b6e2ea8023dd5654960dffe5cd33ead9da8eba515b4423e2ac038f2

data/README.md

@@ -1,10 +1,180 @@
-# Hackademic
+# Hackademic: Create and Manage Your Plain-Text Academic Workflow
 
-## Create and manage your academic workflow
+© 2016 Kizmeta and Matthew Petty [@lodestone](https://git.io/lodestone)
+
+LICENSE MIT
+
+
+# Installation
+
+To install or update Hackademic, open up your Terminal and type `gem install hackademic`.
+
+```ruby
+gem install hackademic
+```
+
+## Hackademic Help
+
+`hackademic help`: could be more helpful, but essentially lists some choices. Ignore any I don't mention in this document. They may be temporary.
+
+```ruby
+> hackademic help
+Commands:
+  hackademic compile [FORMAT]   # Type "hackademic help compile" to see choices
+  hackademic help [COMMAND]     # Describe available commands or one specific command
+  hackademic install_templates  # Install latest pandoc templates
+  hackademic list               # List the current projects in the Projects folder
+  hackademic new [PROJECT]      # Create something new!
+  hackademic setup [FOLDER]     # Setup a new Hackademic repository at [FOLDER]
+  hackademic sync [subcommand]  # Synchronize!
+  hackademic update_pandoc      # Update to latest pandoc and pandoc-citeproc
+
+```
+
+# Hackademic Commands
+
+A List of useful Hackademic Commands
+
+## Creating New Projects: `hackademic new project`
+
+To create a new project, open up your Terminal, `cd` into the directory you want the project to live in (usually `~/Dropbox/Hackademic`), and type the command `hackademic new project`, followed by a space and the name of the new project.
+
+```ruby
+> cd ~/Dropbox/Hackademic
+> hackademic new project <ProjectName>
+```
+
+`hackademic new project [PROJECT_NAME]`: Create a new writing project in your project folder. This command will set up the folder structure, the git repo, and add other necessary files like templates. 
+
+## Listing Current Projects: `hackademic list`
+
+```ruby
+❯ hackademic list
+
+  ❡ hackademic ➤➤➤
+
+    Listing projects found in /Users/lodestone/Dropbox/Hackademic/Projects/
+
+    PX7
+    ShaneDiss
+    ShaneDiss.old
+
+```
+
+`hackademic list`: Spit out a list of projects that hackademic knows about.
+
+
+## Compiling Drafts: `hackademic compile`
+
+`hackademic compile [OPTION]`: Compile your Main Draft into multiple formats using the included templates.  
+**Note:** You should `cd` into the *Project Root Folder* before running this command in the terminal. 
+ 
+
+```ruby
+❯ hackademic help compile
+Commands:
+  hackademic compile all               # compile pdf, word doc, and latex file
+  hackademic compile docx              # compile a docx
+  hackademic compile help [COMMAND]    # Describe subcommands or one specific subcommand
+  hackademic compile latex             # compile a latex document
+  hackademic compile pdf               # compile a pdf
+  hackademic compile show_pdf_command  # Show the pandoc command for pdf generation
+```
+
+`hackademic compile docx`: Compile a Word doc only
+
+`hackademic compile latex`: Compile the LaTeX only
+
+`hackademic compile pdf` Compile a PDF only
+
+`hackademic compile all` will compile a complete, transculded markdown file; a .tex file; MS Word Doc; and PDF.
+
+`hackademic compile show_pdf_command`: Show the actual command that hackademic is running so you can see what's going on, tweak parameters, etc.
+
+
+## Syncing the *Notes* Folders Across Projects: `hackademic sync notes`
+
+`hackademic sync notes`: Sync project-specific notes to the general notes folder.
+
+
+This command synchronizes your project-specific notes in `~/Dropbox/Hackademic/Project/ProjectName/Resources/Notes` with your general notes folder, `~/Dropbox/Hackademic/Notes`.
+
+It takes all the files for a given project and looks for references by name to notes in the note database (`~/Dropbox/Hackademic/Notes`). Those notes get copied over to the project. Further, any notes created in the project get pushed into the note database for happy goodness. 
+
+The benefit here is that you can reuse notes across projects without duplicating your work. Someday, we hope this will be a full-fledged *Zettelkasten*. :-0
+
+Someday, this will be turned into a "background job" that won't require user intervention. 
+
+# Zotero, BetterBibTeX, and Zotfile Preferences for Hackademics
+
+## Zotero Settings
+
+Set Zotero's `Linked Attachment Base Directory` like so:
+
+![Zotero Prefs - Linked Attachment Base Directory](http://z.nx.is/VwJ.png)
+
+## BetterBib{La)TeX Settings
+
+Download the latest version of [BetterBibLaTeX](https://zotplus.github.io/better-bibtex/) from their regularly updated [Git Repo](https://github.com/ZotPlus/zotero-better-bibtex).  
+
+Under the `BetterBibTeX` tab of Zotero's Settings, set the `Citation Key Format` to:
+
+    [auth:fold:lower:nopunct:alphanum]-[year]
+
+![Better BibTeX - Citation Prefs](http://z.nx.is/e3R.png)
+
+## Zotfile
+
+### Zotfile Hidden Setting
+
+In order to get Zotfile to use the stable, bibtex citekey in renaming the pdf attachments, we need to adjust a hidden setting in Firefox itself.
+
+In the Firefox URL bar type:
+
+`about:config`
+
+And hit enter. You will see a warning, just click through. Seriously, Firefox is just trying to scare us. We are trained professionals. We know what we are doing.
+
+Search the page that comes up for:
+
+`extensions.zotfile.wildcards.user`
+
+Double click it and paste the following JSON data in the text box.
+
+```json
+{
+    "1": {
+        "field": "extra",
+        "operations": [
+            {
+                "flags": "g",
+                "function": "exec",
+                "regex": "bibtex: *(.*)",
+                "group": 1
+            }
+        ]
+    }
+}
+```
+
+### Zotfile Preferences
+
+Now we can adjust our Zotfile renaming preferences. Make it look like the following screenshot. For clarity, the format is: `{%1}_{%t}` (That's a 1 (one) not an I or i)
+
+Also make sure to change the maximum length of title to `39`.
+
+
+![Zotfile - Renaming Rules](http://z.nx.is/1sQ.png)
+
+
+You should also set Zotfile's `General Settings` to `/Hackademic-Root-Folder/Libraries/My-Library`. See the following screenshot.
+
+
+![Zotfile - General Settings](http://z.nx.is/Grx.png)
+
+
+Now, **GO FORTH AND DO RESEARCH!**
 
-### Hackademic manages your plain-text academic workflow
 
 
-&copy; 2016 Kizmeta and Matthew Petty [@lodestone](https://git.io/lodestone)
 
-LICENSE MIT

data/hackademic.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'hackademic'
-  s.version       = '0.2.7'
+  s.version       = '0.2.8'
   s.date          = '2016-01-03'
   s.summary       = "Create and manage your academic workflow"
   s.description   = "Hackademic manages your plain-text academic workflow."

data/lib/hackademy/compile.rb

@@ -60,6 +60,7 @@ module Hackademy
         #   #{config.output_directory}/#{config.transcluded_draft}
         # }.gsub(/\s+/, ' ')
         %{pandoc \
+          --template=#{config.pdf_template} \
           -t html5 \
           --bibliography=#{config.bibliography} \
           --csl=#{config.citation_style} \

data/templates/Config.yml.tt

@@ -8,4 +8,6 @@ hackademic:
   citation_style: Resources/csl/american-sociological-association.csl
   docx_template: Resource/templates/pandoc-word-template.docx
   latex_template: Resources/templates/xelatex.template
+  html_template: Resources/templates/default.html5
+  pdf_template: Resources/templates/default.html5
   support_directory: Resources

data/templates/default.html5

@@ -2,55 +2,64 @@
 <html$if(lang)$ lang="$lang$"$endif$$if(dir)$ dir="$dir$"$endif$>
   <head>
     <meta charset="utf-8">
-    <meta name="generator" content="pandoc">
+    <meta name="generator" content="hackademic,pandoc">
     <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
     <style>
       * {
-        font-family: Garamond;
+        font-family: "Garamond";
+      }
+      code {
+        white-space: pre;
       }
     </style>
-  $for(author-meta)$
-    <meta name="author" content="$author-meta$">
-  $endfor$
-  $if(date-meta)$
-    <meta name="dcterms.date" content="$date-meta$">
-  $endif$
-  $if(keywords)$
-    <meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$">
-  $endif$
-    <title>$if(title-prefix)$$title-prefix$ – $endif$$pagetitle$</title>
-    <style type="text/css">code{white-space: pre;}</style>
-  $if(quotes)$
-    <style type="text/css">q { quotes: "“" "”" "‘" "’"; }</style>
-  $endif$
-  $if(highlighting-css)$
-    <style type="text/css">
-  $highlighting-css$
-    </style>
-  $endif$
-  $for(css)$
-    <link rel="stylesheet" href="$css$">
-  $endfor$
-  $if(math)$
-    $math$
-  $endif$
+    $for(author-meta)$
+      <meta name="author" content="$author-meta$">
+    $endfor$
+    $if(date-meta)$
+      <meta name="dcterms.date" content="$date-meta$">
+    $endif$
+    $if(keywords)$
+      <meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$">
+    $endif$
+    <title>
+      $if(title-prefix)$
+        $title-prefix$ –
+      $endif$
+      $if(pagetitle)$
+        $pagetitle$
+      $endif$
+    </title>
+    $if(quotes)$
+      <style type="text/css">q { quotes: "“" "”" "‘" "’"; }</style>
+    $endif$
+    $if(highlighting-css)$
+      <style type="text/css">
+        $highlighting-css$
+      </style>
+    $endif$
+    $for(css)$
+      <link rel="stylesheet" href="$css$">
+    $endfor$
+    $if(math)$
+      $math$
+    $endif$
     <!--[if lt IE 9]>
       <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
     <![endif]-->
-  $for(header-includes)$
-    $header-includes$
-  $endfor$
+    $for(header-includes)$
+      $header-includes$
+    $endfor$
   </head>
   <body>
     $for(include-before)$
-    $include-before$
+      $include-before$
     $endfor$
     $if(title)$
       <header>
         <h1 class="title">$title$</h1>
-        $if(subtitle)$
-          <h1 class="subtitle">$subtitle$</h1>
-        $endif$
+          $if(subtitle)$
+            <h1 class="subtitle">$subtitle$</h1>
+          $endif$
         $for(author)$
           <h2 class="author">$author$</h2>
         $endfor$
@@ -61,12 +70,12 @@
     $endif$
     $if(toc)$
       <nav id="$idprefix$TOC">
-      $toc$
+        $toc$
       </nav>
     $endif$
-  $body$
-  $for(include-after)$
-    $include-after$
-  $endfor$
+    $body$
+    $for(include-after)$
+      $include-after$
+    $endfor$
   </body>
 </html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hackademic
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Matthew Petty