Improve documentation for _index file with i18n

[josineto]

The documentation for _index files doesn't make it clear how to set it up when using multiple locales. I discovered myself that Sveltia CMS automatically detects the locale part of file name, e.g, in _index.pt.md, the .pt part.

I've just started to migrate my collections' index files, from pages in a file collection to index items in collections' list. Initially I tried to set it like the file field in file collections (doesn't work), like this:

...
index_file:
  name: _index.{{locale}}.md   # also tried without the .md part
...

Then I tried _index.pt.md, _index.pt, without success. And finally when I just left it as _index it worked.

This could be in the documentation. It would ease the setup in multilingual sites.

Suggestion: it would be nice to be able to customize the title of the index file, or the term "Index File [home icon]", but it's ok to postpone this to after 1.0.

[kyoshino]

Thanks for the heads-up! I’ll update the README to clarify what the option expects. Actually the name could be optional because this feature is available for Hugo, and the special index file name is always _index.

[josineto]

Thank you for the fast response!

[kyoshino]

Suggestion: it would be nice to be able to customize the title of the index file, or the term "Index File [home icon]", but it's ok to postpone this to after 1.0.

The relevant Decap CMS PR #7382 suggests the label option (though their current PR doesn’t match it), so I’ll add it.

[kyoshino]

v0.84.0 added the label and icon options, made the name optional, and updated the doc accordingly.

[josineto]

@kyoshino there's a problem: the name field is not working as optional. Here it was name: _index, working. When I removed it, it stopped working. If I put it again, it works again, even if its value is the default... I've tried to remove the i18n: true field, but it changes nothing regarding this problem.

[kyoshino]

Checking.

[kyoshino]

If you don’t have any fields for the index file, you have to have an empty object to omit the name as well.

index_file: {}

This is the same as null, making the index file disabled:

index_file:

I’ll update the doc to clarify this case.

[kyoshino]

Actually that’s why I made the name option required for the initial release. 😉