ed. 0.1.1 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -0
- data/README.md +4 -4
- data/_includes/sidebar.html +7 -2
- data/_layouts/default.html +2 -2
- data/_sass/_ed.scss +63 -88
- data/_texts/narrative.md +1 -1
- data/_texts/o-captain.md +0 -1
- data/about.md +2 -2
- data/assets/css/style.scss +31 -1
- data/assets/screenshot-home.png +0 -0
- data/documentation.md +43 -7
- data/optional/balloon-css/_balloon.scss +312 -0
- data/optional/jekyll-scholar starter kit/Rakefile +3 -1
- data/optional/tei-to-ed/tei-to-ed.xsl +158 -0
- metadata +12 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 759390e07ffd6398c7be74abb8c78156d0afc520
|
|
4
|
+
data.tar.gz: 147f635218412cdd6abc641efe2aecfdea56a9e2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0a972b98a79634ea2939aea2705266aabc417e645e65e24e6c421d995be10a55fe309351c547fa0a21176c7f1b2c1962fa553296695bb0dd0e4694540dbef40a
|
|
7
|
+
data.tar.gz: 9429c09f1efbd542322d6b09577686e895f022c8c60891ea6a4a57e2a82945733a674ae3f7166c5ab251a852f50a2141e7eb4088ec3880ec9285b4b514db0cc4
|
data/Gemfile
CHANGED
data/README.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# Ed: A Jekyll Theme for Minimal Editions
|
|
2
2
|
|
|
3
|
-
[](https://travis-ci.org/elotroalex/ed)
|
|
3
|
+
[](https://travis-ci.org/elotroalex/ed) [](https://badge.fury.io/rb/ed.)
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
|
|
7
7
|
|
|
8
8
|
|
|
9
9
|
|
|
@@ -19,7 +19,7 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
|
|
|
19
19
|
|
|
20
20
|
## Sample Ed editions.
|
|
21
21
|
|
|
22
|
-
- [Our sample site](http://
|
|
22
|
+
- [Our sample site](http://minicomp.github.io/ed/) is the first edition built with Ed.
|
|
23
23
|
- [Fugitive Verses](http://fugitiverses.viraltexts.org/): Popular Reprinted Poetry from Nineteenth Century Newspapers
|
|
24
24
|
- [mini lazarillo](http://minilazarillo.github.io/): A minimal edition of the *Lazarillo de Tormes*
|
|
25
25
|
- [Making and Knowing](https://cu-mkp.github.io/GR8975-edition/): The BnF Ms Fr 640 in Translation
|
|
@@ -44,4 +44,4 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
|
|
|
44
44
|
|
|
45
45
|
## Installing and using Ed
|
|
46
46
|
|
|
47
|
-
To learn how to install and begin using Ed, please visit our [documentation page](http://
|
|
47
|
+
To learn how to install and begin using Ed, please visit our [documentation page](http://minicomp.github.io/ed/documentation).
|
data/_includes/sidebar.html
CHANGED
|
@@ -27,13 +27,18 @@
|
|
|
27
27
|
|
|
28
28
|
<!-- The code below is used for manually entered links -->
|
|
29
29
|
|
|
30
|
+
<span style='cursor:pointer;' onclick="javascript:var hypothesis = document.createElement('script');
|
|
31
|
+
hypothesis.setAttribute('src','https://hypothes.is/embed.js');
|
|
32
|
+
document.head.appendChild(hypothesis);"><a class="sidebar-nav-item">Annotate me</a></span>
|
|
30
33
|
|
|
31
|
-
|
|
34
|
+
<!-- <a class="sidebar-nav-item" href="https://via.hypothes.is/{{ site.url }}{{ site.baseurl }}{{page.url}}/" data-proofer-ignore>Annotate me</a> -->
|
|
35
|
+
<!-- -->
|
|
36
|
+
<!-- <script src="https://hypothes.is/embed.js" async></script> -->
|
|
32
37
|
|
|
33
38
|
<a class="sidebar-nav-item" href="https://github.com/elotroalex/ed" target="_blank">GitHub project</a>
|
|
34
39
|
</nav>
|
|
35
40
|
|
|
36
41
|
<div class="sidebar-item">
|
|
37
|
-
<p>Currently
|
|
42
|
+
<p>Currently v1.0 Distributed with an MIT license.</p>
|
|
38
43
|
</div>
|
|
39
44
|
</div>
|
data/_layouts/default.html
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
{% include head.html %}
|
|
5
5
|
|
|
6
|
-
<body>
|
|
6
|
+
<body class="theme-base-{{site.color-scheme}}">
|
|
7
7
|
|
|
8
8
|
<!-- This if statement decides which sidebar to use -->
|
|
9
9
|
{% if page.toc %}
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
<div class="masthead">
|
|
20
20
|
<div class="container">
|
|
21
21
|
<h3 class="masthead-title">
|
|
22
|
-
<a href="{{ site.baseurl }}/" title="Home">{{ site.title }}</a>
|
|
22
|
+
<a href="{{ site.baseurl }}/" title="Home">{{ site.title | newline_to_br }}</a>
|
|
23
23
|
<br><small>{{ site.tagline }}</small>
|
|
24
24
|
</h3>
|
|
25
25
|
</div>
|
data/_sass/_ed.scss
CHANGED
|
@@ -11,22 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
13
|
|
|
14
|
-
/*
|
|
15
|
-
* Common Variables
|
|
16
|
-
*
|
|
17
|
-
* Feel free to change!
|
|
18
|
-
*
|
|
19
|
-
*/
|
|
20
14
|
|
|
21
|
-
$main-font: "Palatino Linotype", "Book Antiqua", Palatino, serif;
|
|
22
|
-
|
|
23
|
-
$heading-font: sans-serif;
|
|
24
|
-
$heading-color: #404040;
|
|
25
|
-
|
|
26
|
-
$text-color: #454545;
|
|
27
|
-
$regular-font-size: 20px;
|
|
28
|
-
|
|
29
|
-
$link-color: #841212;
|
|
30
15
|
|
|
31
16
|
/* To apply a different color scheme to the whole scroll down to the themes section for instructions */
|
|
32
17
|
|
|
@@ -544,128 +529,116 @@ a.sidebar-nav-item:focus {
|
|
|
544
529
|
}
|
|
545
530
|
|
|
546
531
|
|
|
532
|
+
/*
|
|
533
|
+
* Overlay sidebar
|
|
534
|
+
*
|
|
535
|
+
* Make the sidebar content overlay the viewport content instead of pushing it
|
|
536
|
+
* aside when toggled.
|
|
537
|
+
*/
|
|
538
|
+
|
|
539
|
+
.sidebar-overlay #sidebar-checkbox:checked ~ .wrap {
|
|
540
|
+
-webkit-transform: translateX(0);
|
|
541
|
+
-ms-transform: translateX(0);
|
|
542
|
+
transform: translateX(0);
|
|
543
|
+
}
|
|
544
|
+
.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar-toggle {
|
|
545
|
+
box-shadow: 0 0 0 .25rem #fff;
|
|
546
|
+
}
|
|
547
|
+
.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar {
|
|
548
|
+
box-shadow: .25rem 0 .5rem rgba(0,0,0,.1);
|
|
549
|
+
}
|
|
550
|
+
|
|
551
|
+
/* Only one tweak for a reverse layout */
|
|
552
|
+
.layout-reverse.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar {
|
|
553
|
+
box-shadow: -.25rem 0 .5rem rgba(0,0,0,.1);
|
|
554
|
+
}
|
|
555
|
+
|
|
547
556
|
/*
|
|
548
557
|
* Themes
|
|
549
558
|
*
|
|
550
|
-
*
|
|
551
|
-
* Based on colors from Base16: http://chriskempson.github.io/base16/#default.
|
|
559
|
+
* Applies custom color schemes by adding the appropriate class to the `body`. Based on colors from Base16: http://chriskempson.github.io/base16/#default.
|
|
552
560
|
*/
|
|
553
561
|
|
|
554
562
|
/* Red */
|
|
555
|
-
.theme-base-
|
|
556
|
-
.theme-base-
|
|
557
|
-
.theme-base-
|
|
563
|
+
.theme-base-red .sidebar,
|
|
564
|
+
.theme-base-red .sidebar-toggle:active,
|
|
565
|
+
.theme-base-red #sidebar-checkbox:checked ~ .sidebar-toggle {
|
|
558
566
|
background-color: #ac4142;
|
|
559
567
|
}
|
|
560
|
-
.theme-base-
|
|
561
|
-
.theme-base-
|
|
562
|
-
.theme-base-
|
|
568
|
+
.theme-base-red .container a,
|
|
569
|
+
.theme-base-red .sidebar-toggle,
|
|
570
|
+
.theme-base-red .related-posts li a:hover {
|
|
563
571
|
color: #ac4142;
|
|
564
572
|
}
|
|
565
573
|
|
|
566
574
|
/* Orange */
|
|
567
|
-
.theme-base-
|
|
568
|
-
.theme-base-
|
|
575
|
+
.theme-base-orange .sidebar,
|
|
576
|
+
.theme-base-orange .sidebar-toggle:active {
|
|
569
577
|
background-color: #d28445;
|
|
570
578
|
}
|
|
571
|
-
.theme-base-
|
|
572
|
-
.theme-base-
|
|
573
|
-
.theme-base-
|
|
579
|
+
.theme-base-orange .container a,
|
|
580
|
+
.theme-base-orange .sidebar-toggle,
|
|
581
|
+
.theme-base-orange .related-posts li a:hover {
|
|
574
582
|
color: #d28445;
|
|
575
583
|
}
|
|
576
584
|
|
|
577
|
-
/* Yellow */
|
|
578
|
-
.theme-base-0a .sidebar,
|
|
579
|
-
.theme-base-0a .sidebar-toggle:active {
|
|
580
|
-
background-color: #f4bf75;
|
|
581
|
-
}
|
|
582
|
-
.theme-base-0a .container a,
|
|
583
|
-
.theme-base-0a .sidebar-toggle,
|
|
584
|
-
.theme-base-0a .related-posts li a:hover {
|
|
585
|
-
color: #f4bf75;
|
|
586
|
-
}
|
|
587
585
|
|
|
588
586
|
/* Green */
|
|
589
|
-
.theme-base-
|
|
590
|
-
.theme-base-
|
|
587
|
+
.theme-base-green .sidebar,
|
|
588
|
+
.theme-base-green .sidebar-toggle:active {
|
|
591
589
|
background-color: #90a959;
|
|
592
590
|
}
|
|
593
|
-
.theme-base-
|
|
594
|
-
.theme-base-
|
|
595
|
-
.theme-base-
|
|
591
|
+
.theme-base-green .container a,
|
|
592
|
+
.theme-base-green .sidebar-toggle,
|
|
593
|
+
.theme-base-green .related-posts li a:hover {
|
|
596
594
|
color: #90a959;
|
|
597
595
|
}
|
|
598
596
|
|
|
599
597
|
/* Cyan */
|
|
600
|
-
.theme-base-
|
|
601
|
-
.theme-base-
|
|
598
|
+
.theme-base-cyan .sidebar,
|
|
599
|
+
.theme-base-cyan .sidebar-toggle:active {
|
|
602
600
|
background-color: #75b5aa;
|
|
603
601
|
}
|
|
604
|
-
.theme-base-
|
|
605
|
-
.theme-base-
|
|
606
|
-
.theme-base-
|
|
602
|
+
.theme-base-cyan .container a,
|
|
603
|
+
.theme-base-cyan .sidebar-toggle,
|
|
604
|
+
.theme-base-cyan .related-posts li a:hover {
|
|
607
605
|
color: #75b5aa;
|
|
608
606
|
}
|
|
609
607
|
|
|
610
608
|
/* Blue */
|
|
611
|
-
.theme-base-
|
|
612
|
-
.theme-base-
|
|
609
|
+
.theme-base-blue .sidebar,
|
|
610
|
+
.theme-base-blue .sidebar-toggle:active {
|
|
613
611
|
background-color: #6a9fb5;
|
|
614
612
|
}
|
|
615
|
-
.theme-base-
|
|
616
|
-
.theme-base-
|
|
617
|
-
.theme-base-
|
|
613
|
+
.theme-base-blue .container a,
|
|
614
|
+
.theme-base-blue .sidebar-toggle,
|
|
615
|
+
.theme-base-blue .related-posts li a:hover {
|
|
618
616
|
color: #6a9fb5;
|
|
619
617
|
}
|
|
620
618
|
|
|
621
619
|
/* Magenta */
|
|
622
|
-
.theme-base-
|
|
623
|
-
.theme-base-
|
|
620
|
+
.theme-base-magenta .sidebar,
|
|
621
|
+
.theme-base-magenta .sidebar-toggle:active {
|
|
624
622
|
background-color: #aa759f;
|
|
625
623
|
}
|
|
626
|
-
.theme-base-
|
|
627
|
-
.theme-base-
|
|
628
|
-
.theme-base-
|
|
624
|
+
.theme-base-magenta .container a,
|
|
625
|
+
.theme-base-magenta .sidebar-toggle,
|
|
626
|
+
.theme-base-magenta .related-posts li a:hover {
|
|
629
627
|
color: #aa759f;
|
|
630
628
|
}
|
|
631
629
|
|
|
632
630
|
/* Brown */
|
|
633
|
-
.theme-base-
|
|
634
|
-
.theme-base-
|
|
631
|
+
.theme-base-brown .sidebar,
|
|
632
|
+
.theme-base-brown .sidebar-toggle:active {
|
|
635
633
|
background-color: #8f5536;
|
|
636
634
|
}
|
|
637
|
-
.theme-base-
|
|
638
|
-
.theme-base-
|
|
639
|
-
.theme-base-
|
|
635
|
+
.theme-base-brown .container a,
|
|
636
|
+
.theme-base-brown .sidebar-toggle,
|
|
637
|
+
.theme-base-brown .related-posts li a:hover {
|
|
640
638
|
color: #8f5536;
|
|
641
639
|
}
|
|
642
640
|
|
|
643
641
|
|
|
644
|
-
/*
|
|
645
|
-
* Overlay sidebar
|
|
646
|
-
*
|
|
647
|
-
* Make the sidebar content overlay the viewport content instead of pushing it
|
|
648
|
-
* aside when toggled.
|
|
649
|
-
*/
|
|
650
|
-
|
|
651
|
-
.sidebar-overlay #sidebar-checkbox:checked ~ .wrap {
|
|
652
|
-
-webkit-transform: translateX(0);
|
|
653
|
-
-ms-transform: translateX(0);
|
|
654
|
-
transform: translateX(0);
|
|
655
|
-
}
|
|
656
|
-
.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar-toggle {
|
|
657
|
-
box-shadow: 0 0 0 .25rem #fff;
|
|
658
|
-
}
|
|
659
|
-
.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar {
|
|
660
|
-
box-shadow: .25rem 0 .5rem rgba(0,0,0,.1);
|
|
661
|
-
}
|
|
662
|
-
|
|
663
|
-
/* Only one tweak for a reverse layout */
|
|
664
|
-
.layout-reverse.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar {
|
|
665
|
-
box-shadow: -.25rem 0 .5rem rgba(0,0,0,.1);
|
|
666
|
-
}
|
|
667
|
-
|
|
668
|
-
|
|
669
642
|
/* */
|
|
670
643
|
/* ED SPECIAL LAYOUTS */
|
|
671
644
|
/* */
|
|
@@ -869,3 +842,5 @@ li.prose-indent {
|
|
|
869
842
|
text-indent: 2rem;
|
|
870
843
|
}
|
|
871
844
|
|
|
845
|
+
|
|
846
|
+
|
data/_texts/narrative.md
CHANGED
|
@@ -29,7 +29,7 @@ toc:
|
|
|
29
29
|
|
|
30
30
|
## Editor's note
|
|
31
31
|
|
|
32
|
-
This version of *Narrative of the Life of Frederick Douglass* was adapted from *The Project Gutenberg EBook of The Narrative of the Life of Frederick Douglass, by Frederick Douglass*. The [Guttenberg file](
|
|
32
|
+
This version of *Narrative of the Life of Frederick Douglass* was adapted from *The Project Gutenberg EBook of The Narrative of the Life of Frederick Douglass, by Frederick Douglass*. The [Guttenberg file](http://www.gutenberg.org/) does not tell us which witness was used in making their digital edition. The edition below is only a slightly modified version of the Guttenberg text, and therefore should not be taken too seriously as an edition. I use the text mostly to show a few affordances of using Ed for long form narrative. This page, for example, showcases a different sidebar than the rest of our sample site, with a table of content of the novel generated out of metadata in the source file. In addition, reading morsels of the novel on your different devices can give you a sense of the experience of reading prose using Ed, and shows you an example of the optional sidebar with a table of contents. A few other features of this page are described in more detail in the [Documentation]({{ site.baseurl }}/documentation/).
|
|
33
33
|
|
|
34
34
|
---
|
|
35
35
|
|
data/_texts/o-captain.md
CHANGED
|
@@ -15,7 +15,6 @@ source: Poetry Foundation
|
|
|
15
15
|
- {:.indent-5}Where on the deck my Captain lies,
|
|
16
16
|
- {:.indent-6}Fallen cold and dead.
|
|
17
17
|
|
|
18
|
-
|
|
19
18
|
- O Captain! my Captain! rise up and hear the bells;
|
|
20
19
|
- Rise up—for you the flag is flung—for you the bugle[^fn2] trills,
|
|
21
20
|
- For you bouquets and ribbon’d wreaths—for you the shores a-crowding,
|
data/about.md
CHANGED
|
@@ -10,7 +10,7 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
|
|
|
10
10
|
|
|
11
11
|
## Sample Ed editions.
|
|
12
12
|
|
|
13
|
-
- [Our sample site](http://
|
|
13
|
+
- [Our sample site](http://minicomp.github.io/ed/) is the first edition built with Ed.
|
|
14
14
|
- [Fugitive Verses](http://fugitiverses.viraltexts.org/): Popular Reprinted Poetry from Nineteenth Century Newspapers
|
|
15
15
|
- [mini lazarillo](http://minilazarillo.github.io/): A minimal edition of the *Lazarillo de Tormes*
|
|
16
16
|
- [Making and Knowing](https://cu-mkp.github.io/GR8975-edition/): The BnF Ms Fr 640 in Translation
|
|
@@ -35,4 +35,4 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
|
|
|
35
35
|
|
|
36
36
|
## Installing and using Ed
|
|
37
37
|
|
|
38
|
-
To learn how to install and begin using Ed, please visit our [documentation page](http://
|
|
38
|
+
To learn how to install and begin using Ed, please visit our [documentation page](http://minicomp.github.io/ed/documentation/).
|
data/assets/css/style.scss
CHANGED
|
@@ -2,5 +2,35 @@
|
|
|
2
2
|
sitemap: false
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
+
/*
|
|
6
|
+
* Common Variables
|
|
7
|
+
*
|
|
8
|
+
* Feel free to change!
|
|
9
|
+
*
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
/* FONTS */
|
|
13
|
+
|
|
14
|
+
$main-font: "Palatino Linotype", "Book Antiqua", Palatino, serif;
|
|
15
|
+
$heading-font: sans-serif;
|
|
16
|
+
$regular-font-size: 20px;
|
|
17
|
+
|
|
18
|
+
/*
|
|
19
|
+
* COLOR.
|
|
20
|
+
*
|
|
21
|
+
* Make sure to leave color-scheme in config file empty for granular control
|
|
22
|
+
*
|
|
23
|
+
*/
|
|
24
|
+
|
|
25
|
+
$text-color: #454545;
|
|
26
|
+
$heading-color: #404040;
|
|
27
|
+
$link-color: #841212;
|
|
28
|
+
|
|
29
|
+
|
|
5
30
|
@import "ed";
|
|
6
|
-
@import "syntax";
|
|
31
|
+
@import "syntax";
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
Binary file
|
data/documentation.md
CHANGED
|
@@ -123,9 +123,37 @@ Copy the url from your terminal log and paste it into your browser of choice (I
|
|
|
123
123
|
|
|
124
124
|
---
|
|
125
125
|
|
|
126
|
+
## Installing Ed: Replacing an existing Jekyll theme
|
|
127
|
+
|
|
128
|
+
Ed, like Jekyll, is also a gem. Jekyll gives you the option to switch themes, as long as those themes are gems as well. If you have existing content and would like to use Ed, you need to add the following line to your _config.yml file, usually at the bottom:
|
|
129
|
+
|
|
130
|
+
~~~
|
|
131
|
+
theme: "ed."
|
|
132
|
+
~~~
|
|
133
|
+
|
|
134
|
+
You also need to add the gem to your Gemfile file:
|
|
135
|
+
|
|
136
|
+
~~~
|
|
137
|
+
gem "ed.", "0.1.1"
|
|
138
|
+
~~~
|
|
139
|
+
|
|
140
|
+
Make sure to replace the version number with the one you need. I will do my best to document what changes come with each new gem. If your current theme does not have a Gemfile, you would need to create one and add the line above. The Gemfile is a plain text file like all other files in Jekyll, and should not have a file extension.
|
|
141
|
+
|
|
142
|
+
After these files have been modified, you need to update your Bundle in the terminal:
|
|
143
|
+
|
|
144
|
+
~~~ bash
|
|
145
|
+
$ bundle update
|
|
146
|
+
~~~
|
|
147
|
+
|
|
148
|
+
When using the gem on top of a previous theme, you will not have all the files of a full Ed install immediately available to you. More importantly, you may not have a _texts folder. You need to create one or copy them from a full installation of Ed. You might also want to add the search and index file. The gem comes bundled with all these files once you install it on your system, but they won't be in the same folder as your project. To locate them you can refer to the [Jekyll documentation for gem-based themes](https://jekyllrb.com/docs/themes/). With some previous themes you might need to erase lingering files that interfere with the functioning of Ed. This can be an advanced operation I can't do justice to here. At that point you might need to familiarize yourself with the architecture of Jekyll, or pay close attention to errors when you try to serve the site, and reverse-engineer from there.
|
|
149
|
+
|
|
150
|
+
Going forward, updating to a new version of Ed is as simple as changing the release version and running the bundle update. I will try to keep changes in the actual markup to a minimum, but will let users know if any changes require a global find and replace in your editions.
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
126
154
|
## Jekyll
|
|
127
155
|
|
|
128
|
-
Ed is a Jekyll theme. That means you will need some familiarity with Jekyll to take advantage of its full potential. While running a Jekyll site is a bit more involved than Wordpress and other similar tools, the payoff in the long term is worth the effort to learn it. If you are new to Jekyll, I recommend you take a look at ["How (and Why) to Generate a Static Website Using Jekyll"](http://chronicle.com/blogs/profhacker/jekyll1/60913) at ProfHacker,
|
|
156
|
+
Ed is a Jekyll theme. That means you will need some familiarity with Jekyll to take advantage of its full potential. While running a Jekyll site is a bit more involved than Wordpress and other similar tools, the payoff in the long term is worth the effort to learn it. If you are new to Jekyll, I recommend you take a look at ["How (and Why) to Generate a Static Website Using Jekyll"](http://chronicle.com/blogs/profhacker/jekyll1/60913) at ProfHacker, Amanda Visconti's excellent [Building a static website with Jekyll and GitHub Pages](http://programminghistorian.org/lessons/building-static-sites-with-jekyll-github-pages) on *The Programming Historian* and [Jekyll's own documentation](http://jekyllrb.com/) to start getting a sense of how it works.
|
|
129
157
|
|
|
130
158
|
Once you have gone through these tutorials, you can get started using Ed by replacing the sample texts included in in the `_texts` folder in Ed with your own edited texts. Remember to always and only edit files in Ed using [a plain text editor](https://en.wikipedia.org/wiki/Text_editor), and *not* a word processor. I'm composing this file using a plain text editor called [Sublime Text](http://www.sublimetext.com/).
|
|
131
159
|
|
|
@@ -177,7 +205,7 @@ To indent specific lines we take advantage of a feature in kramdown that allows
|
|
|
177
205
|
- {:.indent-6} Fallen cold and dead.
|
|
178
206
|
~~~
|
|
179
207
|
|
|
180
|
-
The `-` at the beginning of each line indicates that these are lines. The `{:.indent-3}` is what we need to in order to indicate the indent value for that line. Values can range from 1-10. You can expand the range or adjust the values in the
|
|
208
|
+
The `-` at the beginning of each line indicates that these are lines. The `{:.indent-3}` is what we need to in order to indicate the indent value for that line. Values can range from 1-10. You can expand the range or adjust the values in the Ed stylesheet (`_ed.scss`) in the `_sass` folder.
|
|
181
209
|
|
|
182
210
|
The example from Raisin in the Sun shows us that we don't need much special markup for theater as long as we use CAPITAL LETTERS for speakers. Italics for directions are easy enough. Just use `*` around the words you want to italicize.
|
|
183
211
|
|
|
@@ -264,7 +292,7 @@ Your editions are treated as [collections](https://jekyllrb.com/docs/collections
|
|
|
264
292
|
|
|
265
293
|
You will notice that the homepage in particular has a `.html` file ending instead of a `.md` ending. All template files in Jekyll are HTML, and the index behaves as a template file. Although these files are mostly written in HTML, notice that they still contain YAML front matter and liquid tags. To edit the homepage replace the content on the file shipped with Ed, making sure that your changes to `index.html` are written in valid HTML. The same goes for the template files in the `_layouts` folder.
|
|
266
294
|
|
|
267
|
-
Ed also comes with a search page, `search.html`. This page implements [elastic lunr](http://elasticlunr.com/), "a lightweight full-text search engine in Javascript for browser search and offline search." This simple search page can be useful if you have large collections of texts. If you don't, and don't feel the need, go ahead and delete it along with the `
|
|
295
|
+
Ed also comes with a search page, `search.html`. This page implements [elastic lunr](http://elasticlunr.com/), "a lightweight full-text search engine in Javascript for browser search and offline search." This simple search page can be useful if you have large collections of texts. If you don't, and don't feel the need, go ahead and delete it along with the `assets/js` folder.
|
|
268
296
|
|
|
269
297
|
Besides the homepage and the search page, Ed ships with an About page, `about.md` and a documentation page, `documentation.md`, i.e. this page. As you can see, these are regular `.md` files. You can replace the contents of each file using normal kramdown syntax. This also applies to any new page you create, which you should remember to save with an `.md` extension. When editing the `bibliography.md` file, be careful not to replace the liquid tag that generates your bibliography, unless you don't want to have a bibliography at all.
|
|
270
298
|
|
|
@@ -367,7 +395,11 @@ Note that our jekyll-scholar starter kit comes ready for MLA style. To use Chica
|
|
|
367
395
|
|
|
368
396
|
**Publishing your site on Github Pages with jekyll-scholar**
|
|
369
397
|
|
|
370
|
-
If you install jekyll-scholar, or most other plugins in Jekyll, you will need a workaround to publish your site on Github Pages, which only runs in 'safe mode.' I've provided a slightly modified version of a `Rakefile` originally created by [Robert Rawlins](https://blog.sorryapp.com/blogging-with-jekyll/2014/01/31/using-jekyll-plugins-on-github-pages.html) that will help you accomplish this task. Once you are ready to publish, switch to your `gh-pages` branch and run the following command
|
|
398
|
+
If you install jekyll-scholar, or most other plugins in Jekyll, you will need a workaround to publish your site on Github Pages, which only runs in 'safe mode.' I've provided a slightly modified version of a `Rakefile` originally created by [Robert Rawlins](https://blog.sorryapp.com/blogging-with-jekyll/2014/01/31/using-jekyll-plugins-on-github-pages.html) that will help you accomplish this task. Once you are ready to publish, switch to your `gh-pages` branch and run the following command:
|
|
399
|
+
|
|
400
|
+
~~~ bash
|
|
401
|
+
$ rake ed:publish
|
|
402
|
+
~~~
|
|
371
403
|
|
|
372
404
|
---
|
|
373
405
|
|
|
@@ -378,10 +410,12 @@ If you install jekyll-scholar, or most other plugins in Jekyll, you will need a
|
|
|
378
410
|
- Make sure to add horizontal rules, `---`, to separate sections in your texts. This creates a more pleasant layout.
|
|
379
411
|
- You can clean unnecessary folders and files from the original Ed package before publishing your site. This will help you reduce overhead. For example, you can erase this page, the sample texts and the `syntax.css` file (used for styling code).
|
|
380
412
|
- Consider providing tips for your readers on how to make their font bigger or smaller by taking advantage of <kbd>Command</kbd> + <kbd>+</kbd> and <kbd>Command</kbd> + <kbd>-</kbd>. Or returning to the top of the page using <kbd>Command</kbd> + <kbd>Up Arrow</kbd>. Part of the philosophy behind Ed is to avoid duplicating features that are already easily available in most web ecosystems.
|
|
381
|
-
- If you want to allow annotations on your site, consider providing a `via.hypothes.is` link. Our sample site can be annotated, for example, using the following link: `https://via.hypothes.is/http://
|
|
413
|
+
- If you want to allow annotations on your site, consider providing a `via.hypothes.is` link. Our sample site can be annotated, for example, using the following link: `https://via.hypothes.is/http://minicomp.github.io/ed/`, which readers can access on the sidebar. Once you've indicated your own URL in the config file, the link will update automatically. Make sure to visit [hypothes.is](https://hypothes.is/) to learn more.
|
|
382
414
|
- Ed includes metadata in the headers that makes it easier for users of Zotero, and other systems to grab bibliographic information for the site and individual texts. Our metadata functionality may not be enough to generate a full proper citation. Consider providing visible citation information in your about page or homepage.
|
|
383
415
|
- Make sure to deepen your knowledge of the building blocks of Ed: Jekyll, YAML and Liquid. A great list of resources can be found in the blog "[Jekyll for Web Designers](http://jameswillweb.github.io/jekyll-for-designers/resources.html)".
|
|
384
416
|
- Our base themes Poole/Lanyon allow for easily customization of the interface. You can, for example, switch the position of the sidebar, change the theme colors and overlay options. To learn more check out the [Lanyon documentation](https://github.com/poole/lanyon#themes), and make sure to try the green, `.theme-base-0b`, it's really nice.
|
|
417
|
+
- You can change the look and feel of the site as a whole by changing the `color-scheme` in the `_config.yml` file. If you want to have more granularity, short of editing the `css`, you can change the variable values in the `assets/css/style.scss` file.
|
|
418
|
+
- In the `optional` folder you will find a sample `xslt` to help you get started converting TEI to Ed. You will also find css for adding pop-up "balloons" or tooltips to your texts.
|
|
385
419
|
|
|
386
420
|
---
|
|
387
421
|
|
|
@@ -414,7 +448,9 @@ If you do decide to use the GitHub pages option, please make sure to read the [n
|
|
|
414
448
|
|
|
415
449
|
To publish on GitHub pages, you must have a copy of the repository in GitHub. That means you also need an account there. Once you've created the repository that you will use, you must link your local repository to the one on GitHub. Notice that because you cloned the original source files from my repository, it will be linked to my repository (to which you don't have writing privileges) until you do this step. Instructions for changing the remote URL can be found [here](https://help.github.com/articles/changing-a-remote-s-url/).
|
|
416
450
|
|
|
417
|
-
|
|
451
|
+
The usual way of doing it is to create a different git branch called `gh-pages` within your local repository for your site. This is a branch is published by GitHub by default. GitHub also gives you the option to select [any branch you want to publish](https://github.com/blog/2228-simpler-github-pages-publishing), including the master branch.
|
|
452
|
+
|
|
453
|
+
In the following I use the gh-pages branch. To create and use that branch use the following command:
|
|
418
454
|
|
|
419
455
|
~~~ bash
|
|
420
456
|
$ git checkout -b gh-pages
|
|
@@ -426,7 +462,7 @@ Once you are using that branch, you are ready to publish your site. To do so use
|
|
|
426
462
|
$ git push origin gh-pages
|
|
427
463
|
~~~
|
|
428
464
|
|
|
429
|
-
You can now access your site using an address that looks like `http://your-username.github.io/your-project-name`. The sample page for Ed, for example, is hosted at [
|
|
465
|
+
You can now access your site using an address that looks like `http://your-username.github.io/your-project-name`. The sample page for Ed, for example, is hosted at [minicomp.github.io/ed](http://minicomp.github.io/ed).
|
|
430
466
|
|
|
431
467
|
**<span id="a-note-on-your-base-url">A note on your base url</span>**
|
|
432
468
|
|
|
@@ -0,0 +1,312 @@
|
|
|
1
|
+
//******
|
|
2
|
+
// SEE https://github.com/kazzkiq/balloon.css
|
|
3
|
+
// ******
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
//
|
|
7
|
+
// Variables
|
|
8
|
+
// -----------------------------------------
|
|
9
|
+
|
|
10
|
+
$balloon-bg: fade-out(#111, .1);
|
|
11
|
+
$balloon-base-size: 12px;
|
|
12
|
+
$balloon-arrow-height: 6px;
|
|
13
|
+
|
|
14
|
+
$breakpoint: 860px; //When to not show annotations
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
//
|
|
18
|
+
// Mixins
|
|
19
|
+
// -----------------------------------------
|
|
20
|
+
|
|
21
|
+
@mixin svg-arrow ($color, $position: up) {
|
|
22
|
+
|
|
23
|
+
$degrees: 0;
|
|
24
|
+
$height: 6px;
|
|
25
|
+
$width: 18px;
|
|
26
|
+
|
|
27
|
+
@if ($position == down) {
|
|
28
|
+
$degrees: 180 18 6;
|
|
29
|
+
} @else if ($position == left) {
|
|
30
|
+
$degrees: -90 18 18;
|
|
31
|
+
$width: 6px;
|
|
32
|
+
$height: 18px;
|
|
33
|
+
} @else if ($position == right) {
|
|
34
|
+
$degrees: 90 6 6;
|
|
35
|
+
$width: 6px;
|
|
36
|
+
$height: 18px;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
background: no-repeat url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="#{$width * 2}" height="#{$height * 2}"><path fill="#{$color}" transform="rotate(#{$degrees})" d="M2.658,0.000 C-13.615,0.000 50.938,0.000 34.662,0.000 C28.662,0.000 23.035,12.002 18.660,12.002 C14.285,12.002 8.594,0.000 2.658,0.000 Z"/></svg>');
|
|
40
|
+
background-size: 100% auto;
|
|
41
|
+
width: $width;
|
|
42
|
+
height: $height;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
@mixin transition ($args...) {
|
|
46
|
+
-webkit-transition: $args;
|
|
47
|
+
-moz-transition: $args;
|
|
48
|
+
-ms-transition: $args;
|
|
49
|
+
-o-transition: $args;
|
|
50
|
+
transition: $args;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
@mixin transform ($val) {
|
|
54
|
+
-webkit-transform: $val;
|
|
55
|
+
-moz-transform: $val;
|
|
56
|
+
-ms-transform: $val;
|
|
57
|
+
transform: $val;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
@mixin transform-origin ($val) {
|
|
61
|
+
-webkit-transform-origin: $val;
|
|
62
|
+
-moz-transform-origin: $val;
|
|
63
|
+
-ms-transform-origin: $val;
|
|
64
|
+
transform-origin: $val;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
@mixin opacity ($trans) {
|
|
68
|
+
filter: alpha(opactiy=($trans * 100));
|
|
69
|
+
-ms-filter: "progid:DXImageTransform.Microsoft.Alpha(Opacity=#{$trans * 100})";
|
|
70
|
+
-moz-opacity: $trans;
|
|
71
|
+
-khtml-opacity: $trans;
|
|
72
|
+
opacity: $trans;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
@mixin base-effects () {
|
|
76
|
+
@include opacity(0);
|
|
77
|
+
pointer-events: none;
|
|
78
|
+
@include transition(all .18s ease-out .18s);
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
//
|
|
83
|
+
// Styles
|
|
84
|
+
// -----------------------------------------
|
|
85
|
+
|
|
86
|
+
@media screen and (min-width: $breakpoint) {
|
|
87
|
+
[data-balloon] {
|
|
88
|
+
position: relative; // alt. absolute or fixed
|
|
89
|
+
|
|
90
|
+
&:after {
|
|
91
|
+
@include base-effects();
|
|
92
|
+
|
|
93
|
+
background: $balloon-bg;
|
|
94
|
+
border-radius: 4px;
|
|
95
|
+
color: #fff;
|
|
96
|
+
content: attr(data-balloon);
|
|
97
|
+
font-family: Helvetcia, sans-serif;
|
|
98
|
+
text-align: left;
|
|
99
|
+
font-size: $balloon-base-size + 2;
|
|
100
|
+
padding: .5em 1em;
|
|
101
|
+
position: absolute;
|
|
102
|
+
white-space: nowrap;
|
|
103
|
+
z-index: 10;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
&:before {
|
|
107
|
+
@include svg-arrow($balloon-bg);
|
|
108
|
+
@include base-effects();
|
|
109
|
+
|
|
110
|
+
content: '';
|
|
111
|
+
position: absolute;
|
|
112
|
+
z-index: 10;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
&:hover {
|
|
116
|
+
&:before,
|
|
117
|
+
&:after {
|
|
118
|
+
@include opacity(1);
|
|
119
|
+
pointer-events: auto;
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
&[data-balloon-break] {
|
|
124
|
+
&:after {
|
|
125
|
+
white-space: normal;
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
&[data-balloon-pos="up"] {
|
|
130
|
+
&:after {
|
|
131
|
+
bottom: 100%;
|
|
132
|
+
left: 50%;
|
|
133
|
+
margin-bottom: 5px + $balloon-arrow-height;
|
|
134
|
+
@include transform(translate(-50%, 10px));
|
|
135
|
+
@include transform-origin(top);
|
|
136
|
+
}
|
|
137
|
+
&:before {
|
|
138
|
+
bottom: 100%;
|
|
139
|
+
left: 50%;
|
|
140
|
+
margin-bottom: 5px;
|
|
141
|
+
@include transform(translate(-50%, 10px));
|
|
142
|
+
@include transform-origin(top);
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
&:hover {
|
|
146
|
+
&:after {
|
|
147
|
+
@include transform(translate(-50%, 0));
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
&:before {
|
|
151
|
+
@include transform(translate(-50%, 0));
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
&[data-balloon-pos='down'] {
|
|
158
|
+
&:after {
|
|
159
|
+
left: 50%;
|
|
160
|
+
margin-top: 5px + $balloon-arrow-height;
|
|
161
|
+
top: 100%;
|
|
162
|
+
@include transform(translate(-50%, -10px));
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
&:before {
|
|
166
|
+
@include svg-arrow($balloon-bg, 'down');
|
|
167
|
+
|
|
168
|
+
left: 50%;
|
|
169
|
+
margin-top: 5px;
|
|
170
|
+
top: 100%;
|
|
171
|
+
@include transform(translate(-50%, -10px));
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
&:hover {
|
|
175
|
+
&:after {
|
|
176
|
+
@include transform(translate(-50%, 0));
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
&:before {
|
|
180
|
+
@include transform(translate(-50%, 0));
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
&[data-balloon-pos='left'] {
|
|
186
|
+
&:after {
|
|
187
|
+
margin-right: 5px + $balloon-arrow-height;
|
|
188
|
+
right: 100%;
|
|
189
|
+
top: 50%;
|
|
190
|
+
@include transform(translate(10px, -50%));
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
&:before {
|
|
194
|
+
@include svg-arrow($balloon-bg, 'left');
|
|
195
|
+
|
|
196
|
+
margin-right: 5px;
|
|
197
|
+
right: 100%;
|
|
198
|
+
top: 50%;
|
|
199
|
+
@include transform(translate(10px, -50%));
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
&:hover {
|
|
203
|
+
&:after {
|
|
204
|
+
@include transform(translate(0, -50%));
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
&:before {
|
|
208
|
+
@include transform(translate(0, -50%));
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
&[data-balloon-pos='right'] {
|
|
215
|
+
&:after {
|
|
216
|
+
|
|
217
|
+
left: 100%;
|
|
218
|
+
margin-left: 5px + $balloon-arrow-height;
|
|
219
|
+
top: 50%;
|
|
220
|
+
@include transform(translate(-10px, -50%));
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
&:before {
|
|
224
|
+
@include svg-arrow($balloon-bg, 'right');
|
|
225
|
+
|
|
226
|
+
left: 100%;
|
|
227
|
+
margin-left: 5px;
|
|
228
|
+
top: 50%;
|
|
229
|
+
@include transform(translate(-10px, -50%));
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
&:hover {
|
|
233
|
+
&:after {
|
|
234
|
+
@include transform(translate(0, -50%));
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
&:before {
|
|
238
|
+
@include transform(translate(0, -50%));
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
&[data-balloon-length='small'] {
|
|
244
|
+
&:after {
|
|
245
|
+
white-space: normal;
|
|
246
|
+
width: 80px;
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
&[data-balloon-length='medium'] {
|
|
251
|
+
&:before {
|
|
252
|
+
white-space: normal;
|
|
253
|
+
width: 150px;
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
&[data-balloon-length='large'] {
|
|
258
|
+
&:after {
|
|
259
|
+
white-space: normal;
|
|
260
|
+
width: 260px;
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
&[data-balloon-length='xlarge'] {
|
|
265
|
+
&:after {
|
|
266
|
+
white-space: normal;
|
|
267
|
+
width: 380px;
|
|
268
|
+
|
|
269
|
+
@media screen and (max-width: 768px) {
|
|
270
|
+
white-space: normal;
|
|
271
|
+
width: 90vw;
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
|
|
276
|
+
&[data-balloon-length='fit'] {
|
|
277
|
+
&:after {
|
|
278
|
+
white-space: normal;
|
|
279
|
+
width: 100%;
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
// Additional styles to make the buttons look like text
|
|
286
|
+
|
|
287
|
+
button {
|
|
288
|
+
border: none;
|
|
289
|
+
background: none;
|
|
290
|
+
font-size: inherit;
|
|
291
|
+
font-family: inherit;
|
|
292
|
+
color: inherit;
|
|
293
|
+
margin: 0;
|
|
294
|
+
padding: 0;
|
|
295
|
+
border-bottom: 1px dotted $dark-grey;
|
|
296
|
+
cursor: help;
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
div#smallscreens {
|
|
300
|
+
display:none;
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
@media screen and (max-width: ($breakpoint - 1)) {
|
|
305
|
+
div#annotatededition {
|
|
306
|
+
display: none;
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
div#smallscreens {
|
|
310
|
+
display:inline;
|
|
311
|
+
}
|
|
312
|
+
}
|
|
@@ -19,8 +19,10 @@ namespace :ed do
|
|
|
19
19
|
# We built this little rake task to help make that a little bit eaiser.
|
|
20
20
|
#
|
|
21
21
|
|
|
22
|
-
#
|
|
22
|
+
# To publish your site:
|
|
23
23
|
# bundle exec rake ed:publish
|
|
24
|
+
|
|
25
|
+
|
|
24
26
|
desc "Publish ed to gh-pages"
|
|
25
27
|
task :publish do
|
|
26
28
|
# Compile the Jekyll site using the config.
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0"
|
|
3
|
+
xmlns:tei="http://www.tei-c.org/ns/1.0" exclude-result-prefixes="#all">
|
|
4
|
+
|
|
5
|
+
<xsl:output encoding="UTF-8" method="text"></xsl:output>
|
|
6
|
+
|
|
7
|
+
<!-- for replacements of fancy quotes in source -->
|
|
8
|
+
<xsl:param name="doubleQuotePat">’</xsl:param>
|
|
9
|
+
<xsl:param name="doubleQuoteRep">'</xsl:param>
|
|
10
|
+
|
|
11
|
+
<xsl:param name="singleQuotePat">‘</xsl:param>
|
|
12
|
+
<xsl:param name="singleQuoteRep">'</xsl:param>
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
<xsl:template match="/">
|
|
16
|
+
<xsl:apply-templates select="//tei:body/tei:div"/>
|
|
17
|
+
</xsl:template>
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<!-- <xsl:strip-space elements="*"/>-->
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<xsl:template match="tei:body/tei:div">
|
|
25
|
+
|
|
26
|
+
<xsl:variable name="sect_id" select="@xml:id"/>
|
|
27
|
+
<xsl:result-document method="text" encoding="utf-8"
|
|
28
|
+
href="_texts/{$sect_id}-annotated.md" omit-xml-declaration="yes">
|
|
29
|
+
|
|
30
|
+
<xsl:text>---
layout: narrative
</xsl:text>
|
|
31
|
+
<xsl:text>title: </xsl:text>
|
|
32
|
+
<xsl:value-of select="normalize-space(tei:head)"/>
|
|
33
|
+
<xsl:text>
</xsl:text>
|
|
34
|
+
<xsl:text>author:</xsl:text>
|
|
35
|
+
<xsl:text>
</xsl:text>
|
|
36
|
+
<xsl:text>mode: annotated</xsl:text>
|
|
37
|
+
<xsl:text>
</xsl:text>
|
|
38
|
+
<xsl:value-of select="tei:teiHeader/fileDesc/titleStmt/author"/>
|
|
39
|
+
<xsl:text>editor: Minimal Edition Class
</xsl:text>
|
|
40
|
+
<xsl:text>rights: Public Domain
</xsl:text>
|
|
41
|
+
<xsl:text>---

</xsl:text>
|
|
42
|
+
|
|
43
|
+
<xsl:apply-templates/>
|
|
44
|
+
|
|
45
|
+
<!-- inline nav -->
|
|
46
|
+
<xsl:text>

</xsl:text>
|
|
47
|
+
<xsl:text><div class="inline-nav" markdown="1">
</xsl:text>
|
|
48
|
+
|
|
49
|
+
<!-- open the div -->
|
|
50
|
+
|
|
51
|
+
<xsl:if test="preceding-sibling::tei:div[1]">
|
|
52
|
+
|
|
53
|
+
<!-- preceding chapter -->
|
|
54
|
+
<xsl:text>[</xsl:text>
|
|
55
|
+
<xsl:value-of select="preceding-sibling::tei:div[1]/tei:head"/>
|
|
56
|
+
<xsl:text>]</xsl:text>
|
|
57
|
+
<xsl:text>({{site.baseurl}}/texts/</xsl:text>
|
|
58
|
+
<xsl:value-of select="preceding-sibling::tei:div[1]/@xml:id"/>
|
|
59
|
+
<xsl:text>-annotated.html){:.previous}
</xsl:text>
|
|
60
|
+
</xsl:if>
|
|
61
|
+
|
|
62
|
+
<xsl:if test="following-sibling::tei:div[1]">
|
|
63
|
+
|
|
64
|
+
<!-- following chapter -->
|
|
65
|
+
<xsl:text>[</xsl:text>
|
|
66
|
+
<xsl:value-of select="following-sibling::tei:div[1]/tei:head"/>
|
|
67
|
+
<xsl:text>]</xsl:text>
|
|
68
|
+
<xsl:text>({{site.baseurl}}/texts/</xsl:text>
|
|
69
|
+
<xsl:value-of select="following-sibling::tei:div[1]/@xml:id"/>
|
|
70
|
+
<xsl:text>-annotated.html){:.following}
</xsl:text>
|
|
71
|
+
</xsl:if>
|
|
72
|
+
|
|
73
|
+
<xsl:text>
</div></xsl:text>
|
|
74
|
+
|
|
75
|
+
<!-- close the div -->
|
|
76
|
+
|
|
77
|
+
</xsl:result-document>
|
|
78
|
+
</xsl:template>
|
|
79
|
+
|
|
80
|
+
<xsl:template match="tei:body/tei:div/tei:head">
|
|
81
|
+
</xsl:template>
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<xsl:template match="tei:head">
|
|
85
|
+
<xsl:text>
</xsl:text>
|
|
86
|
+
<xsl:text>## </xsl:text>
|
|
87
|
+
<xsl:apply-templates></xsl:apply-templates>
|
|
88
|
+
<xsl:text>

</xsl:text>
|
|
89
|
+
</xsl:template>
|
|
90
|
+
|
|
91
|
+
<xsl:template match="tei:p">
|
|
92
|
+
<xsl:text>
</xsl:text>
|
|
93
|
+
<xsl:apply-templates/>
|
|
94
|
+
<xsl:text>
</xsl:text>
|
|
95
|
+
</xsl:template>
|
|
96
|
+
|
|
97
|
+
<!-- data balloons for links to notes -->
|
|
98
|
+
<xsl:template match="tei:ptr">
|
|
99
|
+
<xsl:text> <button markdown="0" data-balloon-pos="up" data-balloon-length="large" data-balloon="</xsl:text>
|
|
100
|
+
<xsl:value-of disable-output-escaping="yes" select="following::tei:note[@xml:id=translate(current()/@target, '#', '')]/replace(replace(replace(replace(., '-', '—'), '\s+', ' '), $doubleQuotePat, $doubleQuoteRep), $singleQuotePat, $singleQuoteRep)" />
|
|
101
|
+
|
|
102
|
+
<!--
|
|
103
|
+
<xsl:message select="translate(current()/@target, '#', '')"></xsl:message>
|
|
104
|
+
-->
|
|
105
|
+
<xsl:text>"></xsl:text>
|
|
106
|
+
<xsl:apply-templates />
|
|
107
|
+
<xsl:text><</xsl:text>span class="note_label"<xsl:text>></xsl:text><xsl:value-of select="@type"/><xsl:text></span> </xsl:text>
|
|
108
|
+
<xsl:text></button> </xsl:text>
|
|
109
|
+
</xsl:template>
|
|
110
|
+
|
|
111
|
+
<!-- sanitize text nodes for kramdown -->
|
|
112
|
+
<xsl:template match="text()">
|
|
113
|
+
<xsl:value-of select="replace(replace(., '-', '—'), '\s+', ' ')"></xsl:value-of>
|
|
114
|
+
</xsl:template>
|
|
115
|
+
|
|
116
|
+
<!-- link to page image -->
|
|
117
|
+
<xsl:template match="tei:pb">
|
|
118
|
+
<xsl:text><a href=""</xsl:text>
|
|
119
|
+
<xsl:value-of select="@facs"></xsl:value-of>
|
|
120
|
+
<xsl:text>"></xsl:text>
|
|
121
|
+
<xsl:text><img src="/assets/photo-icon.png" alt="Enlace al facsímil" style="display:inline-block; margin-bottom:-3px;"></xsl:text>
|
|
122
|
+
<xsl:text></a></xsl:text>
|
|
123
|
+
</xsl:template>
|
|
124
|
+
|
|
125
|
+
<xsl:template match="tei:hi[@rend = 'italic']">
|
|
126
|
+
<span class="italic">
|
|
127
|
+
<xsl:apply-templates/>
|
|
128
|
+
</span>
|
|
129
|
+
</xsl:template>
|
|
130
|
+
|
|
131
|
+
<xsl:template match="tei:hi[@rend = 'bold']">
|
|
132
|
+
<span class="bold">
|
|
133
|
+
<xsl:apply-templates/>
|
|
134
|
+
</span>
|
|
135
|
+
</xsl:template>
|
|
136
|
+
|
|
137
|
+
<!-- data ballonons for tei:app -->
|
|
138
|
+
|
|
139
|
+
<xsl:template match="tei:app">
|
|
140
|
+
<xsl:text> <button markdown="0" data-balloon-pos="up" data-balloon-length="large" data-balloon="in MS: </xsl:text>
|
|
141
|
+
<xsl:value-of disable-output-escaping="yes" select="child::tei:rdg[1]/replace(replace(replace(replace(., '-', '—'), '\s+', ' '), $doubleQuotePat, $doubleQuoteRep), $singleQuotePat, $singleQuoteRep)" />
|
|
142
|
+
<xsl:message select="translate(current()/@target, '#', '')"></xsl:message>
|
|
143
|
+
<xsl:text>"></xsl:text>
|
|
144
|
+
<xsl:text><</xsl:text>span class="note_label"<xsl:text>></xsl:text><xsl:value-of select="@type"/><xsl:text></span> </xsl:text>
|
|
145
|
+
<xsl:text></button> </xsl:text>
|
|
146
|
+
</xsl:template>
|
|
147
|
+
|
|
148
|
+
<xsl:template match="tei:note" >
|
|
149
|
+
<xsl:call-template name="newline"/>
|
|
150
|
+
<xsl:text><</xsl:text>span class="note_label"<xsl:text>></xsl:text><xsl:value-of select="@xml:id"/><xsl:text></span> </xsl:text><xsl:apply-templates/>
|
|
151
|
+
<xsl:call-template name="newline"/>
|
|
152
|
+
</xsl:template>
|
|
153
|
+
|
|
154
|
+
<xsl:template name="newline">
|
|
155
|
+
<xsl:text> </xsl:text>
|
|
156
|
+
</xsl:template>
|
|
157
|
+
|
|
158
|
+
</xsl:stylesheet>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ed.
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 1.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Alex Gil
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2017-
|
|
11
|
+
date: 2017-11-19 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -16,42 +16,42 @@ dependencies:
|
|
|
16
16
|
requirements:
|
|
17
17
|
- - "~>"
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: '3.
|
|
19
|
+
version: '3.6'
|
|
20
20
|
type: :runtime
|
|
21
21
|
prerelease: false
|
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
23
|
requirements:
|
|
24
24
|
- - "~>"
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
|
-
version: '3.
|
|
26
|
+
version: '3.6'
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: bundler
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
|
30
30
|
requirements:
|
|
31
31
|
- - "~>"
|
|
32
32
|
- !ruby/object:Gem::Version
|
|
33
|
-
version: '1.
|
|
33
|
+
version: '1.16'
|
|
34
34
|
type: :development
|
|
35
35
|
prerelease: false
|
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
|
37
37
|
requirements:
|
|
38
38
|
- - "~>"
|
|
39
39
|
- !ruby/object:Gem::Version
|
|
40
|
-
version: '1.
|
|
40
|
+
version: '1.16'
|
|
41
41
|
- !ruby/object:Gem::Dependency
|
|
42
42
|
name: rake
|
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
|
44
44
|
requirements:
|
|
45
45
|
- - "~>"
|
|
46
46
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: '10.
|
|
47
|
+
version: '10.4'
|
|
48
48
|
type: :development
|
|
49
49
|
prerelease: false
|
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
51
|
requirements:
|
|
52
52
|
- - "~>"
|
|
53
53
|
- !ruby/object:Gem::Version
|
|
54
|
-
version: '10.
|
|
54
|
+
version: '10.4'
|
|
55
55
|
description:
|
|
56
56
|
email:
|
|
57
57
|
- colibri.alex@gmail.com
|
|
@@ -86,17 +86,20 @@ files:
|
|
|
86
86
|
- assets/js/elasticlunr.min.js
|
|
87
87
|
- assets/js/search.js
|
|
88
88
|
- assets/open-graph-logo.png
|
|
89
|
+
- assets/screenshot-home.png
|
|
89
90
|
- atom.xml
|
|
90
91
|
- credits.md
|
|
91
92
|
- documentation.md
|
|
92
93
|
- index.html
|
|
94
|
+
- optional/balloon-css/_balloon.scss
|
|
93
95
|
- optional/jekyll-scholar starter kit/Gemfile
|
|
94
96
|
- optional/jekyll-scholar starter kit/Rakefile
|
|
95
97
|
- optional/jekyll-scholar starter kit/_bibliography/references.bib
|
|
96
98
|
- optional/jekyll-scholar starter kit/_config.yml
|
|
97
99
|
- optional/jekyll-scholar starter kit/bibliography.md
|
|
100
|
+
- optional/tei-to-ed/tei-to-ed.xsl
|
|
98
101
|
- search.html
|
|
99
|
-
homepage: http://
|
|
102
|
+
homepage: http://minicomp.github.io/ed/
|
|
100
103
|
licenses:
|
|
101
104
|
- MIT
|
|
102
105
|
metadata: {}
|