Adds `link` Liquid tag to make generation of URL's easier #4624

jeffkole · 2016-03-02T22:58:11Z

This tag mirrors the post_tag functionality but for collections instead of just posts.

jeffkole · 2016-03-02T22:58:48Z

This is a possible solution to #2252.

If the design looks good and the code is good, I can also add docs to describe how to use it.

mattr- · 2016-03-09T14:46:39Z

What's the benefit to linking to a collection? I'm not seeing one at the moment since collections refer to a group of things and a post is a single entity.

jeffkole · 2016-03-13T21:05:16Z

Perhaps this is just misnamed. The tag links to a specific item in a collection, not to the collection itself.

If you have a collection that generates pages (ie, output: true), then you might want to link directly to those pages. For instance, if you have a collection of blog authors and a page with bio is generated for each one, you may want to link to that page for a specific author from the byline of a post page.

budparr · 2016-03-13T23:32:15Z

Not commenting on the PR, necessarily, but the use-case you bring up, @jeffkole, can be accomplished in 3.1 with something like this:

{% assign author = site.authors | where: 'slug', page.author %}

<a href="{{ author[0].url }}"> {{ author[0].title }}</a>

jeffkole · 2016-03-14T16:02:54Z

@budparr Let's say that I have another collection that is of books I have read and written summaries of, and that I like to link to those summary pages in posts that I write. Don't you think it would be nicer for the user to write

In [The Hard Thing About Hard Things]({% collection_url books hard-thing-about-hard-things %}), Ben Horowitz describes...

than

In [The Hard Thing About Hard Things]({% assign book = site.books | where: 'slug', 'hard-thing-about-hard-things' %}{{ book[0].url }}), Ben Horowitz describes...

The first strikes me as a nice clean interface to get a specific job done. It can be documented and tested. The second is obviously more flexible, but it requires knowing more about the internals of Jekyll to use it.

budparr · 2016-03-14T16:11:31Z

@jeffkole - Neither one seems all that easy (I think if I were doing that I'd grab the url directly).

But, I had/have no intention to argue the elegance of the solution. I only brought it up because being able to access a collection item's slug is new as of 3.1, and makes accessing an item much easier than before, so I wanted to make sure you were aware of it.

Cheers!

parkr · 2016-03-15T23:11:40Z

@jeffkole I'm interested in a multi-purpose tag which can work for more than just collection documents.

What do you think about {% link _books/hard-things-about-hard-things.md %}? It'd check against all documents in site.docs_to_write for that relative_path and output the url for that document, or error otherwise.

jeffkole · 2016-03-17T21:02:10Z

@parkr Updated to be a link tag. Let me know what you think. Probably could stand a rebase, and then I can add documentation, too.

envygeeks · 2016-03-17T21:08:43Z

IMO, rebasing is dead now. Github just made it easy to review changes without rebasing.

envygeeks · 2016-03-17T21:09:29Z

test/test_tags.rb

@@ -14,6 +14,9 @@ def create_post(content, override = {}, converter_class = Jekyll::Converters::Ma
    if override['read_posts']
      site.posts.docs.concat(PostReader.new(site).read_posts(''))
    end
+    if override['read_collections']


It would be preferable to make both these if's single line and stack them above the other.

Like this?

site.posts.docs.concat(PostReader.new(site).read_posts('')) if override['read_posts'] CollectionReader.new(site).read if override['read_collections']

Yes, that looks much cleaner!

Isn't that over 90 chars?

@parkr the bot (and I believe Rubocop too) doesn't track line width on Jekyll/Jekyll for now because we have a bunch of lines way over that and it was impacting the score for something so trivial that we could fix over time and didn't impact the actual code or it's readability for the most part.

parkr · 2016-03-24T00:36:53Z

test/test_tags.rb

+    end
+
+    should "have the url to the \"site/generate\" item" do
+      assert_match %r{2\s/methods/site/generate}, @result


Should these have file extensions?

parkr · 2016-03-24T00:37:59Z

Thanks, @jeffkole. One comment above about the tests then I'm 👍 to 🚢.

jeffkole · 2016-03-24T15:56:18Z

Thanks for the review @parkr and @envygeeks. I think this should be good to go now.

parkr · 2016-03-24T19:50:04Z

@jekyllbot: merge +minor

parkr · 2016-03-24T19:50:13Z

Thanks a lot, @jeffkole!

* origin/master: (65 commits) Update history to reflect merge of #4703 [ci skip] Update history to reflect merge of #4712 [ci skip] Highlight the test code Update history to reflect merge of #4640 [ci skip] readded "env=prod"-condition Update history to reflect merge of #3849 [ci skip] Update history to reflect merge of #4624 [ci skip] Update history to reflect merge of #4704 [ci skip] Update history to reflect merge of #4706 [ci skip] Checks for link file extension in tests Updating assets documentation Fix test teardown for cleaner. Update history to reflect merge of #4542 [ci skip] Add explanation of site variables in the example _config.yml Use double quotes in the gemfile Add test for creation of Gemfile by 'jekyll new' Add comment about github-pages Update history to reflect merge of #4533 [ci skip] Ensure Rouge closes its div/figure properly after highlighting ends. Add Site#config= which can be used to set the config ...

kainjow · 2016-08-01T17:19:06Z

Should this tag be documented on the website? It's mentioned in the release notes for 3.2.

parkr · 2016-08-02T00:32:34Z

@kainjow Huh. Yeah, it should be. It should be documented like post_url is, probably at the top of that list.

DirtyF · 2016-08-02T19:00:33Z

@jeffkole A few questions regarding the current implementation:

Should we be able to link to a page with link?
Could we keep the same behavior as post_url and omit the file extension in the relative path?

jeffkole · 2016-08-02T19:39:34Z

@DirtyF You should be able to link to any document that Jekyll is generating, including pages. Is that not working?

As for the file extension, it could certainly be done. I'll leave it to @parkr for guidance, since that kind of stylistic decision is more up to him than me. If he likes it, I can make the changes.

parkr · 2016-08-02T19:41:07Z

Could we keep the same behavior as post_url and omit the file extension in the relative path?

@DirtyF What's the reason for this?

DirtyF · 2016-08-02T19:52:28Z

@jeffkole I didn't manage to link to pages when testing for #5182

@parkr just for cohesiveness between post_url and linktags. IMHO as a user it's not intuitive to have difference between both syntax.

Fixes request made in jekyll#4624 and bug found in jekyll#5182

jeffkole · 2016-08-03T22:09:57Z

Opened #5199 to link to pages and static files.

Adds collection_tag

b80a0cb

This tag mirrors the post_tag functionality but for collections instead of just posts.

parkr added the undetermined label Mar 9, 2016

parkr added the pending-feedback We are waiting for more info. label Mar 12, 2016

parkr added this to the undetermined milestone Mar 15, 2016

parkr added feature and removed undetermined labels Mar 15, 2016

Changes collection_url tag to link tag

f79f9d6

envygeeks reviewed Mar 17, 2016
View reviewed changes

Updates code styling per PR

4b32bd2

parkr reviewed Mar 24, 2016
View reviewed changes

parkr modified the milestones: flexible, undetermined Mar 24, 2016

Checks for link file extension in tests

54fcc97

parkr changed the title ~~Adds collection_tag~~ Adds link Liquid tag to make generation of URL's easier Mar 24, 2016

jekyllbot merged commit da4a664 into jekyll:master Mar 24, 2016

jekyllbot added a commit that referenced this pull request Mar 24, 2016

Update history to reflect merge of #4624 [ci skip]

f0e9b37

parkr removed the pending-feedback We are waiting for more info. label Mar 24, 2016

parkr modified the milestones: 3.2, flexible Mar 24, 2016

jeffkole deleted the feature/add-collection-url-tag branch March 24, 2016 20:07

This was referenced Apr 11, 2016

Add collection support to the "post_url" tag #4777

Closed

Link to a document inside collection via post_url #2540

Closed

Config Permalinks for page and post, and page_url #4519

Closed

DirtyF mentioned this pull request Apr 19, 2016

How to create a link in HTML code that follows "permalink: pretty" syntax? #4811

Closed

DirtyF mentioned this pull request Aug 2, 2016

[site] Document link Liquid tag #5182

Merged

jeffkole mentioned this pull request Aug 2, 2016

Adds documentation for link tag #5186

Closed

jeffkole added a commit to jeffkole/jekyll that referenced this pull request Aug 3, 2016

Adds ability to link to all files

82d6657

Fixes request made in jekyll#4624 and bug found in jekyll#5182

jeffkole mentioned this pull request Aug 3, 2016

Adds ability to link to all files #5199

Merged

mlocher mentioned this pull request Nov 29, 2016

Fix bug where post_url tag matched incorrect post with subdirectory #4873

Merged

jekyll locked and limited conversation to collaborators Jul 5, 2019

jekyllbot added the frozen-due-to-age label Jul 5, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds `link` Liquid tag to make generation of URL's easier #4624

Adds `link` Liquid tag to make generation of URL's easier #4624

jeffkole commented Mar 2, 2016

jeffkole commented Mar 2, 2016

mattr- commented Mar 9, 2016

jeffkole commented Mar 13, 2016

budparr commented Mar 13, 2016

jeffkole commented Mar 14, 2016

budparr commented Mar 14, 2016

parkr commented Mar 15, 2016

jeffkole commented Mar 17, 2016

envygeeks commented Mar 17, 2016

envygeeks Mar 17, 2016

jeffkole Mar 17, 2016

envygeeks Mar 17, 2016

parkr Mar 19, 2016

envygeeks Mar 19, 2016

parkr Mar 24, 2016

parkr commented Mar 24, 2016

jeffkole commented Mar 24, 2016

parkr commented Mar 24, 2016

parkr commented Mar 24, 2016

kainjow commented Aug 1, 2016

parkr commented Aug 2, 2016

DirtyF commented Aug 2, 2016 •

edited

jeffkole commented Aug 2, 2016

parkr commented Aug 2, 2016

DirtyF commented Aug 2, 2016

jeffkole commented Aug 3, 2016

Adds link Liquid tag to make generation of URL's easier #4624

Adds link Liquid tag to make generation of URL's easier #4624

Conversation

jeffkole commented Mar 2, 2016

jeffkole commented Mar 2, 2016

mattr- commented Mar 9, 2016

jeffkole commented Mar 13, 2016

budparr commented Mar 13, 2016

jeffkole commented Mar 14, 2016

budparr commented Mar 14, 2016

parkr commented Mar 15, 2016

jeffkole commented Mar 17, 2016

envygeeks commented Mar 17, 2016

envygeeks Mar 17, 2016

Choose a reason for hiding this comment

jeffkole Mar 17, 2016

Choose a reason for hiding this comment

envygeeks Mar 17, 2016

Choose a reason for hiding this comment

parkr Mar 19, 2016

Choose a reason for hiding this comment

envygeeks Mar 19, 2016

Choose a reason for hiding this comment

parkr Mar 24, 2016

Choose a reason for hiding this comment

parkr commented Mar 24, 2016

jeffkole commented Mar 24, 2016

parkr commented Mar 24, 2016

parkr commented Mar 24, 2016

kainjow commented Aug 1, 2016

parkr commented Aug 2, 2016

DirtyF commented Aug 2, 2016 • edited

jeffkole commented Aug 2, 2016

parkr commented Aug 2, 2016

DirtyF commented Aug 2, 2016

jeffkole commented Aug 3, 2016

Adds `link` Liquid tag to make generation of URL's easier #4624

Adds `link` Liquid tag to make generation of URL's easier #4624

DirtyF commented Aug 2, 2016 •

edited