Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • editors
  • open-analysis-update
  • 48-documentation-guide-on-credit
  • new-jekyll-setup
5 results
Search by author
  • Any Author
  • Alberto Lazari Alberto Lazari alazari
  • Anna Guttesen Anna Guttesen nnm329
  • Bernd Taschler Bernd Taschler ndcn1032
  • Cassandra Gould van Praag Cassandra Gould van Praag cassag
  • David Flitney David Flitney flitney
  • Duncan Mortimer Duncan Mortimer duncan
  • Duncan Smith Duncan Smith dsmith
  • Evan Edmond Evan Edmond edmond
  • Fidel Alfaro Almagro Fidel Alfaro Almagro falmagro
  • Gaurav Bhalerao Gaurav Bhalerao mcz502
  • Juju Fars Juju Fars pfr545
  • Kirralise Hansford Kirralise Hansford bcy376
  • Lara Nikel Lara Nikel lara.nikel
  • Laurence Hunt Laurence Hunt lhunt
  • Lilian Weber Lilian Weber psyc1406
  • Lisa Spiering Lisa Spiering wym003
  • Ludovica Griffanti Ludovica Griffanti ludovica
  • Luke Baxter Luke Baxter lbaxter
  • Marieke Martens Marieke Martens mmartens
  • Mark Jenkinson Mark Jenkinson mark
20 authors
  1. Dec 18, 2022
  3. Dec 17, 2022
  5. Dec 13, 2022
  7. Dec 08, 2022
  9. Dec 05, 2022
  11. Nov 23, 2022
  13. Nov 15, 2022
  15. Nov 05, 2022
  17. Oct 30, 2022
    • Matt Wang's avatar
      Update CHANGELOG.md · ee2e3245
      Matt Wang authored
      ee2e3245
    • Peter Mosses's avatar
      Fix top-level active link (#1015) · 063acaca
      Peter Mosses authored 
      * Fix top-level active link

Fixes #1014

1.  Reverse the order of `page.parent == node.title or page.grand_parent == node.title`. This makes no difference.
2.  Replace `page.parent == node.title` by `page.parent == node.title  and page.grand_parent == nil`. The condition is evaluated first because it is rightmost.
    We have `node in first_level_pages`.
    The old condition holds not only when `page` is a child of `node`,
    but also when `page` is a grandchild of a *different* top-level page and its parent happens to have the same title as `node`.
    The new condition never holds for a grandchild.

This change has been tested locally: in v0.4.0.rc3, when the 3rd-level page `G` was selected, the link to the top-level page `F` was active, and the link to its child `G` was shown; after making the change, it is no longer active, so the link to its child `G` is not shown.

* Update nav.html

Add a comment to clarify just when top-level nodes are active.
      063acaca
  19. Oct 25, 2022
  21. Oct 24, 2022
  23. Oct 20, 2022
  25. Oct 17, 2022
  27. Oct 14, 2022
  29. Oct 10, 2022
    • Matthew Wang's avatar
      prep for v0.4.0.rc3 · c3164b01
      Matthew Wang authored
      c3164b01
    • Matt Wang's avatar
      Update CHANGELOG.md · 55aa714b
      Matt Wang authored
      55aa714b
    • Matt Wang's avatar
      Experimental nav optimization for simple cases (#992) · b4b951fe
      Matt Wang authored 
      
* Optimize simple navigation cases

Fix inefficiency reported in feedback on v0.4.0.rc2 (see discussion #958).

This PR:

* essentially reverts `_includes/nav.html` to v0.4.0.rc1
* preserves the ARIA labels added by #950
* adds a test to optimize builds of sites that rely on `title` fields to order pages.

Building the `endoflife.date` site (130 pages) now takes only about 7 seconds.

Building the `machinetranslate.org` site ( 350 pages) takes about 7 minutes. (Without the added test, it takes just over 5 minutes: the condition of the test is merely to compare the size of two arrays, but that is apparently enough to prevent Jekyll from applying some optimization).

A warning is added to the docs about the need for numbers to be in quotes when used as title values.

* Update navigation-structure.md

A clarification is added to the docs about the need for numbers to be in quotes when used as title values.

* Simplify the control and data flow

- Defer concatenation of `string_order_pages` with `title_order_pages` until needed.
- Replace tests on size with tests for `empty`.
- Rename variables accordingly.

* Fix child nav order

This PR started from the navigation in RC1. Some cosmetic improvements had been made in RC2. This commit adds some of those changes to this PR.

It also fixes a bug (revealed by a new regression test) due to a reference to `node.child_nav_order` instead of `child.child_nav_order`, which prevented reversal of the order in children of children. Presumably a top-level reversal should apply only to direct children, and not to grandchildren. The latter interpretation would be very confusing in a deep multi-level hierarchy.

* Allow pages with numeric titles

An omitted `nav_order` value should default to the `title` value, regardless of its type. Jekyll 3 gives build errors when numbers and strings are sorted together. This commit drops the assumption that `title` values are always strings – a 404 page naturally has a numeric title. It updates the docs page accordingly.

The extra code does not affect the build time for the `endoflife.date` site (7 seconds). For the `machinetranslate` site, changing the title of the 404 page to a number increases the build time from 7 minutes to 9 minutes – the `nav_order` numbers on that site are program-generated in the range 1..1000, which might be atypical.

This commit has not yet been checked using the regression tests.

The gemspec used for testing specifies `spec.add_runtime_dependency "jekyll", "~> 3.8.5"`, and `Gemfile.lock` shows `jekyll (3.8.7)`.

* Update nav.html

Add comment about an optimization that will be possible in Jekyll 4.

* Update nav.html

- Update the comment about optimization possibility.
- TEMPORARILY add Jekyll 3 code for conditionally optimizing.

* Update nav.html

Minor improvements and cosmetic changes.

* Major revision

This update is based on extensive experimentation and profiling with alternative versions of the Liquid code used to build the main navigation panel.

Due to the fragility of Jekyll's optimizations, combining alternative approaches with conditionals turned out to be too expensive: merely adding a condition to check whether some array of pages is empty can add about 20% to the build time!

The current code avoids sorting pages on `nav_order` and `title` fields together. The standard way of doing that in Jekyll is to use the `group_by` filter; but extracting the sorted pages from the groups turned out to be too inefficient (as seen in RC1), as was generating links directly from the groups (in RC2).

Making all pages with `nav_order` values come before all those ordered by their `title` values is not ideal (it doesn't support tweaking the relative order of two pages in a list of pages ordered by their titles) but it appears to be necessary for efficient builds on large sites.

This version has not yet been fully tested for regression, but otherwise seems to give the expected navigation on the endoflife.date and machinetranslate websites. (I'm unable to install the Python-based how2data repository on my laptop, due to package version issues on Apple silicon).

Co-authored-by: default avatarPeter Mosses <18308236+pdmosses@users.noreply.github.com>
      b4b951fe