More examples in the File Fieldtype page

Aberta
  • Algo errado?
#1,102 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
46/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
php
Domínio
documentation

Direção de pesquisa

Start with the File Fieldtype page at docs/fieldtypes/file.html and compare its modifier tag example with the two syntaxes in the issue. Confirm which syntax gives the file title rather than the entry title, then add clear examples to the page showing the expected output. Done means the examples work for the relevant tags and explain when to use each syntax.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Suggested Change
Please add more examples into the File Fieldtype page (https://docs.expressionengine.com/latest/fieldtypes/file.html) ... and honestly, just everywhere in the User Guide.

Reasoning
The one example (https://docs.expressionengine.com/latest/fieldtypes/file.html#using-as-modifier-tags-pairs) that is provided does not work correctly with all of the template tags (for example, does not work with {title} ), therefore you have to make weird workarounds. For example, based on the example this should work:

{news_image:webp}
    <img src="{url}" alt="{title}">
  {/news_image:webp}

Whilst the {url} tag works correctly (returns the .webp file url) ... the {title} tag does not work ... it returns the 'entry' {title}, not the 'file' {title}.

I raised this on Slack, and was told that I had to use the following syntax (which I believe is weird and wrong, but does work).

<img src=“{news_image:webp}” alt=“{news_image}{title}{/news_image}”>

If this is in fact the correct syntax, then it would be good to have a few examples showing this kind of result.

Additional context
I do wonder if this is actually just a bug with the File Fieldtype tags ... and not actually an issue with the docs ... but I honestly don't know, as there are no good examples in the docs!

Linguagem predominante
CSS
Estrelas
22
Forks
79
Merge médio
2d 1h
PRs com merge (30d)
6

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de ExpressionEngine/ExpressionEngine-User-Guide

Todas as issues de ExpressionEngine/ExpressionEngine-User-Guide

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.