Add Content Bags #3651

bep · 2017-06-27T06:44:09Z

This issue has been discussed before: #3462 etc.

A content folder is identified as a bundle if it contains either a _index.* or a index.* file.
For index.* files (i.e. single content pages) type of bundles, the bundle will also include any sub folders (i.e. images etc.).

Thinking in Go terms, we add a new Resource type (a Page is a Resource):

interface Resource {
   Permalink() string
   RelPermalink() string
}

$funnyCatsPage.Pages => [even-more-content.md, more-content.md]
$funnyCatsPage.Resources => [even-more-content.md, more-content.md, cat.jpg, another-cat.jpg]
$funnyCatsPage.Resources.ByType "image" => [cat.jpg, another-cat.jpg]
The sub-content-pages will not have Permalink, i.e they will not be rendered to disk on its own, but will typically be used to compose the "bag page".

A Page is a Resource, but we will need others, one example would be Image, which would have some additional image related properties, such as Width and Height, but also methods to generate alternate versions of that image:

$cat := $funnyCatsPage.GetResource "image" "cat.jpg"
$scaled := $cat.Scale "1000x600"

<img src="{{ $scaled.Permalink }}" width={{ $scaled.Width }} height={{ $scaled.Height }}>

The API above is just an example. But I think this "processing only when needed" will scale better than, say, create 5 different version of every image, even if only a small fraction is in actual use.

NOTE: This proposal is about how the bags in Hugo should look like at its core -- it is not about details in a future image scaling APIs etc. The only way to get this done is to define a fairly narrow scope.

TODO: Permalinking, ...

It's all about establishing community standards 😛
Plugin, Bundle, Package - each has their own well established meanings. Who knows, years from now, maybe there will be some project on GitHub looking for a name for their new feature and somebody would say, "We can't name this feature Bag! Hugo used this for a completely different thing!"
I've seen the term Pack being used here and there. But Bag! Nowhere 😂 Maybe it's a good thing 😉 @onedrawingperday

bep · 2017-06-27T18:35:49Z

We already have Scratch, which is also a little bit funky, and Bag fits nicely into that.

@Jos512 I think most people are familiar with grouping related files in the same folder, and this is just the foundation. But I'm not building a Swiss Army knife until I know I really need it -- and it is still possible to use Hugo as is.

onedrawingperday · 2017-06-27T18:41:00Z

@bep scratch the bag! LMAO!!

bep · 2017-06-27T18:48:18Z

But Bag! Nowhere

Hibernate (Java ORM library) uses Bag for one their collection types ...

moorereason · 2017-06-27T21:00:00Z

@bep,
First of all, this would be another fantastic step forward for Hugo. It's also another item on Steve's "Future of Hugo" brain dump.

Second, I suppose it doesn't really matter, but I like Bundle over Bag. I think Steve called them Bundles. The context here is "content." It's a content bundle, not a software bundle. "Bag" sounds like a bag of crap, which I hope my content is not. 😉

Now, on to my main question:

└── blog
    └── funny-cats
        ├── anothercat.jpg
        ├── cat-article.md
        ├── cat.jpg
        ├── even-more-content.md
        └── more-content.md

Would the default URL for this be /blog/funny-cats/cat-article/ or /blog/funny-cats/. It's a little confusing to me either way. It would normally be created as /blog/funny-cats/cat-article/, but it feels odd to have all of the extra files in a path on disk that doesn't match the path of the output. However, creating /blog/funny-cats/ feels abnormal since the "bag" file is called cat-article.

Surprises and oddities create confusion, add to the cognitive load on the user, and make writing docs harder (and way more necessary).

Suggested Solution

Why not require the use of index.md to create a bag?

└── blog
    └── funny-cats
        ├── anothercat.jpg
        ├── index.md
        ├── cat.jpg
        ├── even-more-content.md
        └── more-content.md

If bag=false for index.md, we treat it as we do now and create three pages:

/blog/funny-cats/
/blog/funny-cats/even-more-content/
/blog/funny-cats/more-content/

If bag=true for index.md, we create only:

/blog/funny-cats/

Nothing about that feels surprising to me.

bep · 2017-06-27T21:05:27Z

/blog/funny-cats/

Yes, however we do it, the "file slug" for the bag will be the container, i.e. the folder, so it should in the URL department behave much like how the /myarticle/index.md works today. We can maybe get rid of the bag=true and continue with the index.md only, let's see how that unfolds.

bep · 2017-06-27T21:11:09Z

As to bundles, I think we should reserve that for "something else" in the future, like "shortcode bundles", plugins, theme bundles, whatever.

budparr · 2017-06-27T21:44:53Z

With apologies for being dense: Do "bags" stand next to Sections, or are Sections inside of "bags." And/or why can't "bags" just be Sections?

I think the concept of sections and subsections and types gives one quite a bit of flexibility and I fear another concept will cause ongoing confusion for users.

And, for what it's worth, I think "collections" is a much more meaningful word and I don't think it matters what Jekyll uses.

bep · 2017-06-27T22:23:06Z

A bag is a Page with some additional Resources. I think all of this would be easier if we just dropped the special name and just call it a Page.

budparr · 2017-06-27T22:28:47Z

I see, so it's an article. Your original proposal seems clearer now that you said that, because "bags" makes it seem like something else entirely.

rdwatters · 2017-06-28T02:01:05Z

pack = 👍
collection = 👍
article = 👍
bag = 👎
bundle = 👎

That said, pack: true is probably my favorite, since this is, from what I can tell, kind of the confluence between an article and list page with the assets packed along with it.

lebarde · 2017-06-28T05:36:19Z

For what I've understood for now, I assume we may not really need such a term. At least it could be transparent for the end user.
What we want to do is add resources to a content, whatever it be a section or a leaf page. It would simply sound natural to me to add a collection of resources inside the front matter, just like this:

resources:
  - res/
  - images/   # directory relative to the current post's location
  - /my-journey-throught-scotland/
  - my-beautiful-landscape.jpg

Note that I have mixed absolute directories, relative ones, and direct links to files. This may be discussed.

But why do we need more than a resource name? IMHO it would simply sound more natural. In the end, the Bag, Bundle or whatever would be transparent if this is a name that is implemented in the code. And inside the code we could use something more descriptive, such as ContentResources.

Do I have I missed something?

Jos512 · 2017-06-28T06:03:09Z

What we want to do is add resources to a content, whatever it be a section or a leaf page. It would simply sound natural to me to add a collection of resources inside the front matter.

I like this approach. Also because it can be used to specify which files from /static/ belong to the bag (or what the name becomes). With that, people who like to put their static files in /content/ alongside the content file can do that (for the automatic generation of bag).

And people with 'legacy' websites made with Hugo don't have to restructure their content to use bags but can simply do so with the front matter. And with the imageConfig function we already have, Hugo can already read files on the system so it might probably not be that hard to implement.

Fixes gohugoio#3651 Closes gohugoio#3158 Fixes gohugoio#1014

This commit also improves on the following: * Symbolic links are now allowed anywhere inside /content Fixes gohugoio#3651 Closes gohugoio#3158 Fixes gohugoio#1014 Closes gohugoio#2021 Updates gohugoio#3757

bep · 2017-12-22T20:40:03Z

To the curious:

I plan to cut a release sometime next week, I want to get this out before the new year.

This is going to be really, really cool.

This commit also improves on the following: * Symbolic links are now allowed anywhere inside /content Fixes gohugoio#3651 Closes gohugoio#3158 Fixes gohugoio#1014 Closes gohugoio#2021 Fixes gohugoio#1240 Updates gohugoio#3757

This commit is not the smallest in Hugo's history. Some hightlights include: * Page bundles (for complete articles, keeping images and content together etc.). * Bundled images can be processed in as many versions/sizes as you need with the three methods `Resize`, `Fill` and `Fit`. * Processed images are cached inside `resources/_gen/images` (default) in your project. * Symbolic links (both files and dirs) are now allowed anywhere inside /content * A new table based build summary * The "Total in nn ms" now reports the total including the handling of the files inside /static. So if it now reports more than you're used to, it is just **more real** and probably faster than before (see below). Fixes gohugoio#3651 Closes gohugoio#3158 Fixes gohugoio#1014 Closes gohugoio#2021 Fixes gohugoio#1240 Updates gohugoio#3757

This commit is not the smallest in Hugo's history. Some hightlights include: * Page bundles (for complete articles, keeping images and content together etc.). * Bundled images can be processed in as many versions/sizes as you need with the three methods `Resize`, `Fill` and `Fit`. * Processed images are cached inside `resources/_gen/images` (default) in your project. * Symbolic links (both files and dirs) are now allowed anywhere inside /content * A new table based build summary * The "Total in nn ms" now reports the total including the handling of the files inside /static. So if it now reports more than you're used to, it is just **more real** and probably faster than before (see below). A site building benchmark run compared to `v0.31.1` shows that this should be slightly faster and use less memory: ```bash ▶ ./benchSite.sh "TOML,num_langs=.*,num_root_sections=5,num_pages=(500|1000),tags_per_page=5,shortcodes,render" benchmark old ns/op new ns/op delta BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 101785785 78067944 -23.30% BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 185481057 149159919 -19.58% BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 103149918 85679409 -16.94% BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 203515478 169208775 -16.86% benchmark old allocs new allocs delta BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 532464 391539 -26.47% BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1056549 772702 -26.87% BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 555974 406630 -26.86% BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 1086545 789922 -27.30% benchmark old bytes new bytes delta BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 53243246 43598155 -18.12% BenchmarkSiteBuilding/TOML,num_langs=1,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 105811617 86087116 -18.64% BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=500,tags_per_page=5,shortcodes,render-4 54558852 44545097 -18.35% BenchmarkSiteBuilding/TOML,num_langs=3,num_root_sections=5,num_pages=1000,tags_per_page=5,shortcodes,render-4 106903858 86978413 -18.64% ``` Fixes gohugoio#3651 Closes gohugoio#3158 Fixes gohugoio#1014 Closes gohugoio#2021 Fixes gohugoio#1240 Updates gohugoio#3757

achamess · 2018-01-02T20:46:31Z

This looks great and just what I'm looking for. I really prefer to keep images and .md files together in a folder. Is this feature live yet?

bep · 2018-01-02T20:49:54Z

Is this feature live yet?

Yes.

achamess · 2018-01-02T21:17:40Z

@bep Thanks! I updated to v0.32. Is there anything special I should do? Any documentation? Sorry for the naive questions.

bep · 2018-01-02T21:19:44Z

Please use https://discourse.gohugo.io/ for questions/troubleshooting. Also see Hugo Documentation.

achamess · 2018-01-02T21:21:03Z

Got it. Thanks!

…

On Jan 2, 2018, at 4:20 PM, Bjørn Erik Pedersen ***@***.***> wrote: Please use https://discourse.gohugo.io/ <https://discourse.gohugo.io/> for questions/troubleshooting. Also see Hugo Documentation <http://gohugo.io/overview/introduction/>. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#3651 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHGbchRTEz2CJiQMkKKPspw2JJI6fSr1ks5tGp2EgaJpZM4OGNPQ>.

Add simple multilingual capabilities to the CMS. Languages can be added and configured in the config in the following fashion: ```yaml all_languages: en: name: English flag: 🇬🇧 es: name: French flag: 🇫🇷 default_languages: en enabled_languages: - en - fr ``` Both `enabled_languages` and the `default_language` *must be defined* in the `all_languages` section, the CMS will exit with an error if this is not the case. A document's show page has a new dropdown that enables the initiation of a new translation; this process currently copies the default language file `xyz.md` to the location where the translation will sit, `xyz.fr.md`. Eventually, an XLIFF[0] downloader or some kind of hook into Google Translate[1] is probably going to make this page a bit more useful. There are a couple of outstanding problems, namely that if a document has attachments/assets and is translated, the way Hugo builds the final site means the paths break. This will be fixed by the upcoming Bundles functionality[2]. [0] https://en.wikipedia.org/wiki/XLIFF [1] https://cloud.google.com/translate/docs/ [2] gohugoio/hugo#3651

github-actions · 2022-03-09T02:00:00Z

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

bep added InProgress Proposal labels Jun 27, 2017

bep self-assigned this Jun 27, 2017

This was referenced Jun 27, 2017

Disable single page output for designated sections #3612

Closed

Proposal: allow for keeping text and post-related resources in the same folder #3462

Closed

bep removed the InProgress label Jun 27, 2017

bep changed the title ~~Work In Progress: proposal: Bundles~~ proposal: Bundles Jun 27, 2017

bep added this to the v0.25 milestone Jun 27, 2017

bep changed the title ~~proposal: Bundles~~ proposal: Bags Jun 27, 2017

bep added a commit to bep/hugo that referenced this issue Dec 20, 2017

Implement Page bundling and image handling

a581667

Fixes gohugoio#3651 Closes gohugoio#3158 Fixes gohugoio#1014

nhoizey mentioned this issue Dec 21, 2017

Images in markdown relative to content #1240

Closed

bep closed this as completed in 3cdf19e Dec 27, 2017

dependencies bot mentioned this issue Dec 31, 2017

Update https://github.com/gohugoio/hugo in repo_dependencies.yml from v0.31 to v0.32 matrixik/dobek.pro#5

Closed

github-actions bot added the Outdated label Mar 9, 2022

github-actions bot locked as resolved and limited conversation to collaborators Mar 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Content Bags #3651

Add Content Bags #3651

bep commented Jun 27, 2017 •

edited

Loading

lebarde commented Jun 27, 2017 •

edited

Loading

bep commented Jun 27, 2017

bep commented Jun 27, 2017

MunifTanjim commented Jun 27, 2017

bep commented Jun 27, 2017

MunifTanjim commented Jun 27, 2017

Jos512 commented Jun 27, 2017

onedrawingperday commented Jun 27, 2017 •

edited

Loading

MunifTanjim commented Jun 27, 2017

bep commented Jun 27, 2017

onedrawingperday commented Jun 27, 2017

bep commented Jun 27, 2017

moorereason commented Jun 27, 2017

bep commented Jun 27, 2017 •

edited

Loading

bep commented Jun 27, 2017

budparr commented Jun 27, 2017

bep commented Jun 27, 2017

budparr commented Jun 27, 2017

rdwatters commented Jun 28, 2017 •

edited

Loading

lebarde commented Jun 28, 2017

Jos512 commented Jun 28, 2017

bep commented Dec 22, 2017

achamess commented Jan 2, 2018

bep commented Jan 2, 2018

achamess commented Jan 2, 2018

bep commented Jan 2, 2018

achamess commented Jan 2, 2018 via email

github-actions bot commented Mar 9, 2022

Add Content Bags #3651

Add Content Bags #3651

Comments

bep commented Jun 27, 2017 • edited Loading

Related

lebarde commented Jun 27, 2017 • edited Loading

bep commented Jun 27, 2017

bep commented Jun 27, 2017

MunifTanjim commented Jun 27, 2017

bep commented Jun 27, 2017

MunifTanjim commented Jun 27, 2017

Jos512 commented Jun 27, 2017

onedrawingperday commented Jun 27, 2017 • edited Loading

MunifTanjim commented Jun 27, 2017

bep commented Jun 27, 2017

onedrawingperday commented Jun 27, 2017

bep commented Jun 27, 2017

moorereason commented Jun 27, 2017

Suggested Solution

bep commented Jun 27, 2017 • edited Loading

bep commented Jun 27, 2017

budparr commented Jun 27, 2017

bep commented Jun 27, 2017

budparr commented Jun 27, 2017

rdwatters commented Jun 28, 2017 • edited Loading

lebarde commented Jun 28, 2017

Jos512 commented Jun 28, 2017

bep commented Dec 22, 2017

achamess commented Jan 2, 2018

bep commented Jan 2, 2018

achamess commented Jan 2, 2018

bep commented Jan 2, 2018

achamess commented Jan 2, 2018 via email

github-actions bot commented Mar 9, 2022

bep commented Jun 27, 2017 •

edited

Loading

lebarde commented Jun 27, 2017 •

edited

Loading

onedrawingperday commented Jun 27, 2017 •

edited

Loading

bep commented Jun 27, 2017 •

edited

Loading

rdwatters commented Jun 28, 2017 •

edited

Loading