More examples in the File Fieldtype page

Abierto
  • ¿Algo no está bien?
#1,102 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
46/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
php
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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!

Lenguaje dominante
CSS
Estrellas
22
Forks
79
Merge medio
2 d 1 h
PR fusionados (30 d)
6

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ExpressionEngine/ExpressionEngine-User-Guide

Todos los issues de ExpressionEngine/ExpressionEngine-User-Guide

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.