jekyll-theme-paperwiki 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd5647356250d27a51862ad94ca40a17ba4ec33bec742b95d09a3dc38c0f3d9b
-  data.tar.gz: 817ac6d86315dac8b99e4e8c88f07ae5d5ecb0b4028f4fa70ca21127287ece04
+  metadata.gz: 96dc441b57acdaf6886f2e20b25d4b95855cef23475163a86fd42dfaafcc282e
+  data.tar.gz: 0b11702d89f94b83299c46118f9d7cee573774ba775611cf72168aa5a135a527
 SHA512:
-  metadata.gz: c0ead5a13368865eca2b9c0d8c190dd563182b5b3ec085214b34230203583196e2fc2d2c4efe192cec12fb151ae75fba9a19977136c7eda1252de50b5664a163
-  data.tar.gz: 89ae3bfe1fc0eaf2ef2bf0991bb2eb0e74c44be1f9f8f1c9ae25fd0c08a0e4bf5759c581498e35528ea31d2124a27647071b6644288ce659b1d933b2dfb5cfca
+  metadata.gz: 308ed2f06df61653cf4ee6a45c79bb3164a00c42d3cc94a8645530dfda98942f5c345f42588a50317eb78e4491bf1ff1fde52609c983fe96644f71fb2cec5502
+  data.tar.gz: 6944c6581d6f26a18f823d50c11ae19dbec6c73a5141473f5ce1a02f657f251afd7b5fc3f23957714f77eb1458a6b466949ff5ec559b9cd8ee54d00350c4c08d

data/README.md

@@ -1,8 +1,12 @@
 # jekyll-theme-paperwiki
 
-The intent of this theme is to get all the code out of the way and to allow you to write Markdown articles; the best way to do that is to install the theme as a gem. However, if you want to tinker with the code, just download this repository.
+For storing your worldbuilding notes! The intent of this theme is to get all the code out of the way and to allow you to write Markdown articles; the best way to do that is to install the theme as a gem. However, if you want to tinker with the code, just download this repository.
 
-This theme is not mobile friendly, as I personally do absolutely no worldbuilding on mobile and thus my development skills are lacking. There is also no dark mode or other alternate colour scheme, but please feel free to fork this project and add whatever functionality it's missing.
+For the easiest starting point, I have uploaded a sample site that you can download with everything preconfigured, so if you're unfamiliar with Jekyll you can bypass all the setup and get right to it. See that repo for instructions.
+
+I've tried to adhere to accessible and easy to read design principles while retaining the look and layout of a classic wiki that we're all familiar with - I've aped some elements of Wikipedia's organizational system and layout while trying to make it as clean and user friendly as possible.
+
+This theme is not mobile friendly, as I personally do absolutely no work on mobile and thus my development skills are lacking. There is also no dark mode or other alternate colour scheme, but please feel free to fork this project and add whatever functionality it's missing.
 
 
 
@@ -15,7 +19,7 @@ In case you're unfamiliar with it, a basic Jekyll site includes the following:
 + The `_site` folder contains everything that Jekyll outputs when it builds the site. Don't edit anything in this folder, as it will be rewritten the next time you serve the site.
 + The `assets` folder contains things like fonts, images, and Javascript files. It also contains a `.scss` file importing all of your SCSS so that Jekyll can convert it to regular CSS.
 
-This theme comes with all of these prepackaged, so most of what you have to do is edit the `_config.yaml` file. The theme has some default config set already, but you can override these in your own config file if you wish. You can also add any of the above folders with includes, layouts, or SCSS to override the theme's own files. For example, you will want to add your own `assets` folder to store your own images, including one titled `favicon.png` in order to override the placeholder one i've included.
+This theme comes with all of these prepackaged, so most of what you have to do is edit the `_config.yaml` file. The theme has some default config set already, but you can override these in your own config file if you wish. You can also add any of the above folders to your own project with includes, layouts, or SCSS to override the theme's files. For example, you will want to add your own `assets` folder to store your own images, including one titled `favicon.png` in order to override the placeholder one i've included.
 
 
 
@@ -46,12 +50,10 @@ This will give you a very bare bones Jekyll site, with an index page, a folder f
 
 (Don't worry about the .gitignore or the Gemfile.lock.)
 
-(You can also move your `_posts` folder into your `collections` folder if you want; I find it makes things a little neater.)
-
 To use this theme, open your Jekyll site's `Gemfile`, delete the line that says `gem "minima"` and replace it with this line:
 
 ```ruby
-gem "jekyll-theme-paperwiki", "~> 0.1.2"
+gem "jekyll-theme-paperwiki", "~> 0.1.4"
 ```
 
 And add this line to your Jekyll site's `_config.yml`:
@@ -97,7 +99,11 @@ All of your wiki pages should be written in markdown, and you must begin each `.
 
 Between these two lines is where you include *front matter*, such as specifying the layout or the permalink to the page. However, you can leave the front matter blank - wiki pages have layouts and permalinks set by default in the theme's config file, and you only need to specify them if you want to override the defaults. You also do not need to specify a title for the page, as it is automatically taken from the filename. All you absolutely need is the two triple-dashed lines, as Jekyll needs it to know that the front matter is there in order to output the page.
 
-​
+Caveats:
+- If the site won't build due to an error with the random page, make sure you have more than one wiki article for it to draw from
+- You may need to specify a permalink and a title if you want to use certain characters that are not allowed in filenames -- say, some IPA characters. Otherwise just title your articles "Article title.md", with spaces, not underscores or hyphens, and the default settings will take care of the rest.
+
+
 
 ## Config
 
@@ -116,7 +122,8 @@ collections:
 However, if you would like to have additional collections akin to the Wikimedia Foundation's other projects - such as Wikisource, Wikispecies, or Wiktionary - then you can specify them in the same format as above, also under the `collections` key:
 
 ```yaml
-   collection_name:
+collections:
+   COLLECTION_NAME:
       output: true
       permalink: /:collection/:name
 ```
@@ -138,9 +145,9 @@ You will also need to add a data file listing your projects: create a folder tit
   desc: A brief description here
 ```
 
-For the icon, find one you like from RemixIcon and copy the code.
+For the icon, find one you like from [RemixIcon](https://remixicon.com/) and copy the code.
 
-This will add links to each different collection on your homepage, and allow you to limit the scope of your searches to a single collection or expand it to cover all of them at once. You do not need to do anything to
+This will add links to each different collection on your homepage, and allow you to limit the scope of your searches to a single collection or expand it to cover all of them at once. The search logic is already taken care of in the theme itself; it just needs the names of your collections.
 
 
 

data/_config.yml

@@ -1,14 +1,32 @@
 # Build settings
 include: ['_pages'] # forces custom pages to be organized into their own directory
 
+# Plugins
+# plugins:
+#    - jekyll-ipa
+
+random_redirect:
+   pages: true
+
+multi_projects: true
+entry_tags_top: true
+
+
+
+# Sets the collections directory and defines your collections.
 collections_dir: collections
 collections:
    wiki:
       output: true
       permalink: /:collection/:name
+   works:
+      output: true
+      permalink: /:collection/:name
+   grammars:
+      output: true
+      permalink: /:collection/:name
+
 
-random_redirect:
-   pages: true
 
 # Front matter defaults, so you don't need to set layouts on every new page.
 # As long as pages are in the correct folder, they'll automatically have the
@@ -33,3 +51,15 @@ defaults:
          type: "wiki"
       values:
          layout: "wiki"
+   -
+      scope:
+         path: "_works" # all pages in the works folder
+         type: "works"
+      values:
+         layout: "work"
+   -
+      scope:
+         path: "_grammars" # all pages in the grammars folder
+         type: "grammars"
+      values:
+         layout: "grammar"

data/_includes/collections_header.html

@@ -4,11 +4,7 @@
       {% for item in site.data.projects %}
          {% if page.url contains item.link %}
             Total number of {{ item.name | downcase }} entries:
-            {% if item.name == "Wiki" %}
-               {{ site.wiki.size }}
-            {% else %}
-               ? for now
-            {% endif %}
+               <strong>{{ site.[page.project].size }}</strong>
          {% endif %}
       {% endfor %}
    </section>

data/_includes/entry_tags.html

@@ -0,0 +1,36 @@
+<div class="entry-subhead_pair">
+
+   <span class="entry-subhead_key">Portals:</span>
+   <span>
+      <a href="/{{ page.collection }}/portal:{{ page.portal }}" class="entry-subhead_value">
+         {{ page.portal }}
+      </a>
+   </span>
+
+</div>
+
+<div class="entry-subhead_pair">
+
+   <span class="entry-subhead_key">Categories:</span>
+   <span>
+      {% for item in page.categories %}
+         <a href="/{{ page.collection }}/category:{{ item | slugify }}" class="entry-subhead_value">
+            {{ item }}
+         </a>
+      {% endfor %}
+   </span>
+
+</div>
+
+<div class="entry-subhead_pair">
+
+   <span class="entry-subhead_key">Tags:</span>
+   <span>
+      {% for item in page.tags %}
+         <a href="/{{ page.category }}/tag:{{ item }}" class="entry-subhead_value">
+            {{ item }}
+         </a>
+      {% endfor %}
+   </span>
+
+</div>

data/_includes/search_results.html

@@ -0,0 +1,8 @@
+"{{ page.url | slugify }}": {
+   "title": "{{ page.title | xml_escape }}",
+   "content": {{ page.content | markdownify | strip_newlines | strip_html | jsonify }},
+   "portal": "{{ page.portal | xml_escape }}",
+   "categories": "{{ page.categories | array_to_sentence_string: "" | xml_escape }}",
+   "url": "{{ site.url | append: page.url | xml_escape }}",
+   "path": "{{ page.url | xml_escape }}"
+}

data/_includes/wiki_sidebar.html

@@ -0,0 +1,67 @@
+<section class="entry-sidebar">
+
+   {% if page.other_projects %}
+
+      <section class="entry-other_projects">
+         View in other collections:
+         <ul>
+            {% for item in page.other_projects %}
+               <li>
+                  <a href="/{{ item }}{{ page.url | remove_first: "/wiki" }}">{{ item | capitalize }}</a>
+               </li>
+            {% endfor %}
+         </ul>
+      </section>
+
+   {% endif %}
+
+
+   {% if page.image %}
+      <figure>
+         <img src="{{ page.image }}" width=auto class="entry-image">
+         {% if page.image_caption %}
+            <figcaption>{{ page.image_caption }}</figcaption>
+         {% endif %}
+      </figure>
+   {% endif %}
+
+
+
+   {% if page.quickstats %}
+
+      <section class="entry-quickstats">
+
+         <table class="stats-table">
+            {% for stat in page.quickstats %}
+               {% if stat[0] == "colspan_2" %}
+                  <tr>
+                     <td colspan="2" class="entry-quickstats_double">
+                        {{ stat[1] | replace: "_", " " | capitalize }}
+                     </td>
+                  </tr>
+               {% else %}
+                  <tr>
+                     <td>{{ stat[0] | replace: "_", " " | capitalize }}</td>
+                     <td>{{ stat[1] }}</td>
+                  </tr>
+               {% endif %}
+            {% endfor %}
+         </table>
+
+      </section>
+
+   {% endif %}
+
+
+
+   {% if page.quicknotes %}
+
+      <section class="entry-quicknotes">
+
+         {{ page.quicknotes }}
+
+      </section>
+
+   {% endif %}
+
+<section>

data/_layouts/entry.html

@@ -4,6 +4,14 @@
 
 <nav class="entry-index">
 
+   <ul class="entry-index_return">
+      <li>
+         <a href="/{{ page.collection }}">
+            ← Return to {{ page.collection | capitalize }}
+         </a>
+      </li>
+   </ul>
+
 </nav>
 
 {{ content }}

data/_layouts/search.html

@@ -0,0 +1,12 @@
+---
+   layout: page
+---
+
+<h1>{{ page.title }}</h1>
+
+<dl id="search-results"></dl>
+
+{{ content }}
+
+<script src="/assets/js/lunr.js"></script>
+<script src="/assets/js/search.js"></script>

data/_layouts/wiki.html

@@ -4,121 +4,24 @@
 
 <article class="entry entry-wiki">
 
-
-
    <h1>
       {{ page.title }}
    </h1>
 
-
-
-   {% if page.other_projects %}
-
-      <section class="entry-other_projects">
-         View in other collections:
-         <ul>
-            {% for item in page.other_projects %}
-               <li>
-                  <a href="/{{ item }}{{ page.url | remove_first: "/wiki" }}">{{ item | capitalize }}</a>
-               </li>
-            {% endfor %}
-         </ul>
+   {% if site.entry_tags_top %}
+      <section class="entry-tags entry-tags_top">
+         {% include entry_tags.html %}
       </section>
-
    {% endif %}
 
-
-
-   <section class="entry-tags">
-
-      <div class="entry-subhead_pair">
-
-         <span class="entry-subhead_key">Portals:</span>
-         <span>
-            <a href="/wiki/portal:{{ page.portal }} class="entry-subhead_value"">
-               {{ page.portal }}
-            </a>
-         </span>
-
-      </div>
-
-      <div class="entry-subhead_pair">
-
-         <span class="entry-subhead_key">Categories:</span>
-         <span>
-            {% for item in page.categories %}
-               <a href="/wiki/category:{{ item | slugify }}" class="entry-subhead_value">
-                  {{ item }}
-               </a>
-            {% endfor %}
-         </span>
-
-      </div>
-
-      <div class="entry-subhead_pair">
-
-         <span class="entry-subhead_key">Tags:</span>
-         <span>
-            {% for item in page.tags %}
-               <a href="/wiki/tag:{{ item }}" class="entry-subhead_value">
-                  {{ item }}
-               </a>
-            {% endfor %}
-         </span>
-
-      </div>
-
-   </section>
-
    {{ content }}
 
-</article>
-
-
-
-{% if page.quickstats %}
-
-   <section class="entry-quickstats">
-
-      {% if page.image %}
-         <figure>
-            <img src="{{ page.image }}" width=auto class="stats-image">
-            <figcaption>{{ page.image_caption }}</figcaption>
-         </figure>
-      {% endif %}
-
-      <section class="stats-facts">
-
-         <table class="stats-table">
-            {% if page.type == "person" %}
-               <tr><td>Name</td><td>{{ page.fullname }}</td></tr>
-               <tr><td>Birthday</td><td>{{ page.birthday }}</td></tr>
-               <tr><td>Birthplace</td><td>{{ page.birthplace }}</td></tr>
-               <tr><td>Known for</td><td>{{ page.known_for }}</td></tr>
-            {% endif %}
-            {% if page.type == "planet" %}
-               <tr><td>Orbital period</td><td>{{ page.orbital_period }}</td></tr>
-               <tr><td>Semimajor axis</td><td>{{ page.semimajor_axis }}</td></tr>
-               <tr><td>Orbital eccentricity</td><td>{{ page.eccentricity }}</td></tr>
-               <tr><td>Aphelion</td><td>{{ page.aphelion }}</td></tr>
-               <tr><td>Perihelion</td><td>{{ page.perihelion }}</td></tr>
-               <tr><td>Orbital speed</td><td>{{ page.orbital_speed }}</td></tr>
-               <tr><td>Orbital period</td><td>{{ page.orbital_period }}</td></tr>
-               <tr><td>Orbital inclination</td><td>{{ page.orbital_inclination }}</td></tr>
-               <tr><td>Satellites</td><td>{{ page.satellites }}</td></tr>
-               <tr><td>Radius (mean)</td><td>{{ page.radius }}</td></tr>
-               <tr><td>Radius (equatorial)</td><td>{{ page.radius_equatorial }}</td></tr>
-               <tr><td>Radius (polar)</td><td>{{ page.radius_polar }}</td></tr>
-               <tr><td>Circumference</td><td>{{ page.circumference }}</td></tr>
-               <tr><td>Surface area</td><td>{{ page.surface_area }}</td></tr>
-               <tr><td>Sidereal day</td><td>{{ page.sidereal_day }}</td></tr>
-               <tr><td>Synodic day</td><td>{{ page.synodic_day }}</td></tr>
-               <tr><td>Axial tilt</td><td>{{ page.axial_tilt }}</td></tr>
-            {% endif %}
-         </table>
-
+   {% if site.entry_tags_top == false %}
+      <section class="entry-tags entry-tags_bottom">
+         {% include entry_tags.html %}
       </section>
+   {% endif %}
 
-   </section>
+</article>
 
-{% endif %}
+{% include wiki_sidebar.html %}

data/_plugins/blockquote.rb

@@ -0,0 +1,28 @@
+# usage: {% blockquote text[0] text[1] text[2]%}
+# usage: {% blockquote text[0] text[1] text[2]%}
+# text[0]: the text of the blockquote
+# text[1]: the author of the blockquote
+# text[2]: the source of the blockquote
+
+module Jekyll
+   module Tags
+      class RenderBlockquoteTag < Liquid::Tag
+
+         require "shellwords"
+
+         # initialize is called when we encounter the {% blockquote %} Liquid tag; 'blockquote' is the tag name and anything immediately after it is passed in via the second argument
+         def initialize(tag_name, text, tokens)
+            super
+            @text = text.shellsplit
+         end
+
+         def render(context)
+            "<figure><blockquote>#{@text[0]}<figcaption>#{@text[1]}, <cite>#{@text[2]}</cite></figcaption></blockquote></figure>"
+         end
+
+      end
+   end
+end
+
+# The register_tag method takes two arguments: the user-facing name of the tag [blockquote], and the class that implements it [RenderBlockquoteTag].
+Liquid::Template.register_tag("blockquote", Jekyll::Tags::RenderBlockquoteTag)

data/_plugins/gloss.rb

@@ -3,14 +3,14 @@ module Jekyll
 
       def gloss(input) # will be available as the "gloss" filter
          @text = input
-#         puts "<tr>"
+         puts "<table><tbody><tr>"
 
-#         lexemes = @text.split(" ")
-#         lexemes.each do |word|
-#            puts "<td class=\"gloss_item\">#{word}</td>"
-#         end
+         lexemes = @text.split(" ")
+         lexemes.each do |word|
+            puts "<td class=\"gloss_item\">#{word}</td>"
+         end
 
-#         puts "</tr>"
+         puts "</tr></tbody><table>"
 
 #         morphemic_analysis
 #         morphemic_gloss

data/_plugins/interlinear.rb

@@ -1,3 +1,11 @@
+# usage:
+# {% interlinear %}
+#    sentence in object lang
+#    sentence in object lang broken down into morphemes
+#    interlinear gloss of morphemes
+#    translation into target lang
+# {% endinterlinear %}
+
 module Jekyll
    module Tags
       class InterlinearGlossTag < Liquid::Block
@@ -7,13 +15,18 @@ module Jekyll
          # initialize is called when we encounter the {% interlinear %} Liquid tag; 'interlinear' is the tag name and anything immediately after it is passed in via the second argument
          def initialize(tag_name, text, tokens)
             super
-#            @text = text.shellsplit
-#            @wordcount = @text[0].length
+            @text = text.shellsplit # splits the input string into individual words
+            # @wordcount = @text[0].length # counts the number of words in the string
+
             # object_lang, morphemic_analysis, morphemic_gloss, target_lang
          end
 
          def render(context)
-#            "<table class=\"interlinear-gloss\"><tbody><tr><td colspan=\"7\">#{@text[0]}</td></tr>" + "<tr><td>#{@text[1]}</td></tr></tbody></table>"
+            "<table class=\"interlinear-gloss\">
+               <tbody>
+                  <tr>
+                     <td colspan=\"#{@wordcount}\">#{@text[0]}</td>
+                  </tr>" + "<tr><td>#{@text[1]}</td></tr><tr><td>#{@text[2]}</td></tr><tr><td>#{@text[3]}</td></tr></tbody></table>"
          end
 
       end
@@ -21,4 +34,4 @@ module Jekyll
 end
 
 # The register_tag method takes two arguments: the user-facing name of the tag [interlinear], and the class that implements it [InterlinearGlossTag].
-Liquid::Template.register_tag('interlinear', Jekyll::Tags::InterlinearGlossTag)
+Liquid::Template.register_tag("interlinear", Jekyll::Tags::InterlinearGlossTag)

data/_plugins/ipa.rb

@@ -1,7 +1,11 @@
+# usage: {% ipa /phonemic text/%}
+# usage: {% ipa [phonetic text]%}
+
 module Jekyll
    module Tags
       class RenderPhoneticTag < Liquid::Tag
 
+         # initialize is called when we encounter the {% ipa %} Liquid tag; 'ipa' is the tag name and anything immediately after it is passed in via the second argument
          def initialize(tag_name, text, tokens)
             super
             @text = text
@@ -15,5 +19,5 @@ module Jekyll
    end
 end
 
-# The register_tag method takes two arguments: the user-facing name of the tag [lang], and the class that implements it [DefineLanguageTag].
+# The register_tag method takes two arguments: the user-facing name of the tag [ipa], and the class that implements it [RenderPhoneticTag].
 Liquid::Template.register_tag("ipa", Jekyll::Tags::RenderPhoneticTag)

data/_plugins/lang.rb

@@ -1,5 +1,5 @@
-# usage: {% lang text[0] text[1]     text[2] %}
-# usage: {% lang ko      바이 괕 모    iced jelly dish %}
+# usage: {% lang text[0] text[1]     text[2]%}
+# usage: {% lang ko      바이 괕 모    iced jelly dish%}
 # text[0] = language code
 # text[1] = the text, in latin script or not
 # text[2] = the translation into english
@@ -10,6 +10,7 @@ module Jekyll
 
          require "shellwords"
 
+         # initialize is called when we encounter the {% lang %} Liquid tag; 'lang' is the tag name and anything immediately after it is passed in via the second argument
          def initialize(tag_name, text, tokens)
             super
             @text = text.shellsplit

data/_plugins/sidenote.rb

@@ -0,0 +1,24 @@
+# usage: {% sidenote %}
+
+module Jekyll
+   module Tags
+      class RenderSideNoteTag < Liquid::Tag
+
+         require "shellwords"
+
+         # initialize is called when we encounter the {% sidenote %} Liquid tag; 'sidenote' is the tag name and anything immediately after it is passed in via the second argument
+         def initialize(tag_name, text, tokens)
+            super
+            @text = text.shellsplit
+         end
+
+         def render(context)
+            "<label for='#{@text[0]}' class='margin-toggle sidenote-number'></label><input type='checkbox' id='#{@text[0]}' class='margin-toggle'/><span class='sidenote'>#{@text[1]} </span>"
+         end
+
+      end
+   end
+end
+
+# The register_tag method takes two arguments: the user-facing name of the tag [sidenote], and the class that implements it [RenderSideNoteTag].
+Liquid::Template.register_tag("sidenote", Jekyll::Tags::RenderSideNoteTag)