Chapter page #236

tyohan · 2019-10-25T07:25:49Z

Notes on this PR:

chapter template design implementation ( still need some touch on details )
table of content automatically generated
not include permalink to headings( Add the ability to permalink all chapter headings and figures #199 ) but with the current implementation it will be easy to generate a permalink to each heading
authors box, the authors will automatically generated from config data. Will not shows up if the authors metadata can't found a match from contributors data in config
previous and next chapter button will automatically generated from config, the script will iterate through all chapters in config and will set previous and next button once it found the same chapter number from chapter metadata.
change the methodology page CSS file to page.css and reuse the CSS file with this chapter page

* added chapter template * refactor methodology page to share CSS styles with chapter page

tyohan · 2019-10-25T11:25:34Z

Got some error after merge with master

  File "generate_chapters.py", line 160, in <module>
    generate_chapters()
  File "generate_chapters.py", line 76, in generate_chapters
    write_template(language, year, chapter, metadata, body, tochtml)
  File "generate_chapters.py", line 125, in write_template
    file_to_write.write(template.format(body=body, metadata=metadata, toc=tochtml, authors=authors, prevnext=prevnext))
ValueError: expected ':' after conversion specifier

Will try to fix this first

tyohan · 2019-10-25T11:48:43Z

Ok, all good now. It should be safe.

mikegeyser · 2019-10-25T12:22:08Z

src/templates/en/2019/chapter.html

@@ -1,26 +1,36 @@
-{# IMPORTANT!
+{{# IMPORTANT!


Hi @tyohan, the changes that were made to the chapter.html in #222 were so that we can use Node + Showdown + EJS to statically generate the templates - because mistune wasn't generating tables (amongst other potential problems).

If we add the extra curly braces back, it will break the ejs rendering of the markdown. The work done in #232 is supposed to try and help with this, but I'm not sure how best to proceed?

@mikegeyser sorry accidentally click re-request review button.

Noted on showdown. Let me try to work around this thing and see if we can combine our works.

We should only maintain one markdown parsing script and given that mistune doesn't support markdown tables within HTML, we should deprecate this mistune version in favor of the showdown script @mikegeyser is building.

Sorry that you put so much work into this script and for any confusion as we migrated tools. Having only one script will simplify things a lot.

tyohan · 2019-10-25T14:35:18Z

@rviscomi there are 2 ways to merge my code and @mikegeyser :

Let showdown generate the body through Node but others generate with Python and mistune. We can use Naked to run Node from Python, so we just need to call it once from Python script.
Move some of my code to Flash app route, so contributors and previous & next navigation will render there.

WDYT?

rviscomi · 2019-10-25T16:05:13Z

src/requirements.txt

@@ -1,9 +1,44 @@
+argh==0.26.2


Wow this is a lot of new requirements! Where did they all come from?

I was installing the mistune contrib module and trying to update the the requirements but didn't realized it somehow generated all of these :|

rviscomi · 2019-10-25T16:16:10Z

src/templates/en/2019/chapter_author.html

@@ -0,0 +1,24 @@
+{% for author in authors %}


Rather than individual template files for each of these components, we can generate them in the existing chapter template file.

Similar to the render_byline macro in base_chapter.html.

rviscomi · 2019-10-25T16:19:43Z

src/templates/en/2019/chapter_prevnext.html

@@ -0,0 +1,25 @@
+<nav id="chapter-navigation">


I don't think we need to generate these as part of the markdown rendering. We have the chapter info in 2019.json and we can render them server-side.

Also we might not launch with all 20 chapters, so some are marked todo in the config. These links should go to the next/previous sequential chapter that isn't still marked "todo". That should be done dynamically on the server-side because it could change after the markdown is initially rendered.

rviscomi · 2019-10-25T16:20:14Z

src/templates/ja/2019/chapter_author.html

@@ -0,0 +1,24 @@
+{% for author in authors %}


No need to update Japanese templates, we can leave that for the final translation step.

rviscomi · 2019-10-25T16:21:39Z

src/templates/en/2019/chapter.html

@@ -1,26 +1,36 @@
-{# IMPORTANT!
+{{# IMPORTANT!


We should only maintain one markdown parsing script and given that mistune doesn't support markdown tables within HTML, we should deprecate this mistune version in favor of the showdown script @mikegeyser is building.

Sorry that you put so much work into this script and for any confusion as we migrated tools. Having only one script will simplify things a lot.

rviscomi · 2019-10-29T02:45:01Z

@tyohan any progress on this PR? I think most of the TOC work can be reverted (sorry) and we can proceed with the markup/style changes.

tyohan · 2019-10-29T11:06:28Z

Noted, i'll push in a few hours.

tyohan · 2019-10-29T11:45:26Z

I have a new PR #251. Feel free to delete this branch.

tyohan added 3 commits October 22, 2019 16:57

Preview chapter page (#130)

46af688

* added chapter template * refactor methodology page to share CSS styles with chapter page

Fixing on the index toggle button {#130)

3edf66b

Added author box & prev next navigation (#130,#232)

2151545

tyohan requested review from mikegeyser and rviscomi October 25, 2019 07:25

Merge branch 'master' into chapter-page

21cda34

Fixing error on generate chapters (#236)

a5bfd0b

mikegeyser reviewed Oct 25, 2019

View reviewed changes

tyohan requested a review from mikegeyser October 25, 2019 13:21

rviscomi requested changes Oct 25, 2019

View reviewed changes

rviscomi added the development Building the Almanac tech stack label Oct 25, 2019

rviscomi added this to the Infrastructure complete milestone Oct 25, 2019

rviscomi added the ASAP This issue is blocking progress label Oct 29, 2019

rviscomi closed this Oct 29, 2019

tunetheweb deleted the chapter-page branch November 27, 2019 11:45

rviscomi removed the ASAP This issue is blocking progress label Feb 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chapter page #236

Chapter page #236

tyohan commented Oct 25, 2019

tyohan commented Oct 25, 2019 •

edited

Loading

tyohan commented Oct 25, 2019

mikegeyser Oct 25, 2019

tyohan Oct 25, 2019

rviscomi Oct 25, 2019

tyohan commented Oct 25, 2019

rviscomi Oct 25, 2019

tyohan Oct 27, 2019

rviscomi Oct 25, 2019

rviscomi Oct 25, 2019

rviscomi Oct 25, 2019

rviscomi Oct 25, 2019

rviscomi commented Oct 29, 2019

tyohan commented Oct 29, 2019

tyohan commented Oct 29, 2019

Chapter page #236

Chapter page #236

Conversation

tyohan commented Oct 25, 2019

tyohan commented Oct 25, 2019 • edited Loading

tyohan commented Oct 25, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tyohan commented Oct 25, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rviscomi commented Oct 29, 2019

tyohan commented Oct 29, 2019

tyohan commented Oct 29, 2019

tyohan commented Oct 25, 2019 •

edited

Loading