Added alt attribute to img tags in docs.
This is a good practice for accessibility. Thanks Jessica McKellar for the report.
This commit is contained in:
parent
17824e2b74
commit
29a80354ab
|
@ -68,7 +68,7 @@ Basic usage
|
||||||
|
|
||||||
.. code-block:: html+django
|
.. code-block:: html+django
|
||||||
|
|
||||||
<img src="{{ STATIC_URL }}images/hi.jpg" />
|
<img src="{{ STATIC_URL }}images/hi.jpg" alt="Hi!" />
|
||||||
|
|
||||||
See :ref:`staticfiles-in-templates` for more details, **including** an
|
See :ref:`staticfiles-in-templates` for more details, **including** an
|
||||||
alternate method using a template tag.
|
alternate method using a template tag.
|
||||||
|
@ -131,7 +131,7 @@ You could, of course, simply hardcode the path to you assets in the templates:
|
||||||
|
|
||||||
.. code-block:: html
|
.. code-block:: html
|
||||||
|
|
||||||
<img src="http://static.example.com/static/myimage.jpg" />
|
<img src="http://static.example.com/static/myimage.jpg" alt="Sample image" />
|
||||||
|
|
||||||
Of course, there are some serious problems with this: it doesn't work well in
|
Of course, there are some serious problems with this: it doesn't work well in
|
||||||
development, and it makes it *very* hard to change where you've deployed your
|
development, and it makes it *very* hard to change where you've deployed your
|
||||||
|
@ -167,7 +167,7 @@ Once that's done, you can refer to :setting:`STATIC_URL` in your templates:
|
||||||
|
|
||||||
.. code-block:: html+django
|
.. code-block:: html+django
|
||||||
|
|
||||||
<img src="{{ STATIC_URL }}images/hi.jpg" />
|
<img src="{{ STATIC_URL }}images/hi.jpg" alt="Hi!" />
|
||||||
|
|
||||||
If ``{{ STATIC_URL }}`` isn't working in your template, you're probably not
|
If ``{{ STATIC_URL }}`` isn't working in your template, you're probably not
|
||||||
using :class:`~django.template.RequestContext` when rendering the template.
|
using :class:`~django.template.RequestContext` when rendering the template.
|
||||||
|
@ -193,7 +193,7 @@ tag. It builds the URL for the given relative path by using the configured
|
||||||
.. code-block:: html+django
|
.. code-block:: html+django
|
||||||
|
|
||||||
{% load staticfiles %}
|
{% load staticfiles %}
|
||||||
<img src="{% static "images/hi.jpg" %}" />
|
<img src="{% static "images/hi.jpg" %}" alt="Hi!"/>
|
||||||
|
|
||||||
It is also able to consume standard context variables, e.g. assuming a
|
It is also able to consume standard context variables, e.g. assuming a
|
||||||
``user_stylesheet`` variable is passed to the template:
|
``user_stylesheet`` variable is passed to the template:
|
||||||
|
|
|
@ -279,7 +279,7 @@ Here's what the "base.html" template might look like:
|
||||||
<title>{% block title %}{% endblock %}</title>
|
<title>{% block title %}{% endblock %}</title>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<img src="sitelogo.gif" alt="Logo" />
|
<img src="sitelogo.png" alt="Logo" />
|
||||||
{% block content %}{% endblock %}
|
{% block content %}{% endblock %}
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
|
@ -380,10 +380,10 @@ full URL for the given relative path, e.g.:
|
||||||
.. code-block:: html+django
|
.. code-block:: html+django
|
||||||
|
|
||||||
{% load static from staticfiles %}
|
{% load static from staticfiles %}
|
||||||
<img src="{% static "css/base.css" %}" />
|
<img src="{% static "images/hi.jpg" %}" alt="Hi!" />
|
||||||
|
|
||||||
The previous example is equal to calling the ``url`` method of an instance of
|
The previous example is equal to calling the ``url`` method of an instance of
|
||||||
:setting:`STATICFILES_STORAGE` with ``"css/base.css"``. This is especially
|
:setting:`STATICFILES_STORAGE` with ``"images/hi.jpg"``. This is especially
|
||||||
useful when using a non-local storage backend to deploy files as documented
|
useful when using a non-local storage backend to deploy files as documented
|
||||||
in :ref:`staticfiles-from-cdn`.
|
in :ref:`staticfiles-from-cdn`.
|
||||||
|
|
||||||
|
|
|
@ -683,7 +683,7 @@ directory on the filesystem. Has three special arguments, of which the first is
|
||||||
Optional. A regular expression, as a string, that :class:`FilePathField`
|
Optional. A regular expression, as a string, that :class:`FilePathField`
|
||||||
will use to filter filenames. Note that the regex will be applied to the
|
will use to filter filenames. Note that the regex will be applied to the
|
||||||
base filename, not the full path. Example: ``"foo.*\.txt$"``, which will
|
base filename, not the full path. Example: ``"foo.*\.txt$"``, which will
|
||||||
match a file called ``foo23.txt`` but not ``bar.txt`` or ``foo23.gif``.
|
match a file called ``foo23.txt`` but not ``bar.txt`` or ``foo23.png``.
|
||||||
|
|
||||||
.. attribute:: FilePathField.recursive
|
.. attribute:: FilePathField.recursive
|
||||||
|
|
||||||
|
@ -714,9 +714,9 @@ base filename, not the full path. So, this example::
|
||||||
|
|
||||||
FilePathField(path="/home/images", match="foo.*", recursive=True)
|
FilePathField(path="/home/images", match="foo.*", recursive=True)
|
||||||
|
|
||||||
...will match ``/home/images/foo.gif`` but not ``/home/images/foo/bar.gif``
|
...will match ``/home/images/foo.png`` but not ``/home/images/foo/bar.png``
|
||||||
because the :attr:`~FilePathField.match` applies to the base filename
|
because the :attr:`~FilePathField.match` applies to the base filename
|
||||||
(``foo.gif`` and ``bar.gif``).
|
(``foo.png`` and ``bar.png``).
|
||||||
|
|
||||||
By default, :class:`FilePathField` instances are
|
By default, :class:`FilePathField` instances are
|
||||||
created as ``varchar(100)`` columns in your database. As with other fields, you
|
created as ``varchar(100)`` columns in your database. As with other fields, you
|
||||||
|
|
|
@ -1069,7 +1069,8 @@ value to a maximum value, and then applies that ratio to a constant.
|
||||||
|
|
||||||
For example::
|
For example::
|
||||||
|
|
||||||
<img src="bar.gif" height="10" width="{% widthratio this_value max_value 100 %}" />
|
<img src="bar.png" alt="Bar"
|
||||||
|
height="10" width="{% widthratio this_value max_value 100 %}" />
|
||||||
|
|
||||||
Above, if ``this_value`` is 175 and ``max_value`` is 200, the image in the
|
Above, if ``this_value`` is 175 and ``max_value`` is 200, the image in the
|
||||||
above example will be 88 pixels wide (because 175/200 = .875; .875 * 100 = 87.5
|
above example will be 88 pixels wide (because 175/200 = .875; .875 * 100 = 87.5
|
||||||
|
@ -2361,7 +2362,7 @@ using :class:`~django.template.RequestContext` or not.
|
||||||
.. code-block:: html+django
|
.. code-block:: html+django
|
||||||
|
|
||||||
{% load static %}
|
{% load static %}
|
||||||
<img src="{% static "images/hi.jpg" %}" />
|
<img src="{% static "images/hi.jpg" %}" alt="Hi!" />
|
||||||
|
|
||||||
It is also able to consume standard context variables, e.g. assuming a
|
It is also able to consume standard context variables, e.g. assuming a
|
||||||
``user_stylesheet`` variable is passed to the template:
|
``user_stylesheet`` variable is passed to the template:
|
||||||
|
@ -2380,7 +2381,7 @@ It is also able to consume standard context variables, e.g. assuming a
|
||||||
:ref:`using a cloud service to serve static files<staticfiles-from-cdn>`::
|
:ref:`using a cloud service to serve static files<staticfiles-from-cdn>`::
|
||||||
|
|
||||||
{% load static from staticfiles %}
|
{% load static from staticfiles %}
|
||||||
<img src="{% static "images/hi.jpg" %}" />
|
<img src="{% static "images/hi.jpg" %}" alt="Hi!" />
|
||||||
|
|
||||||
.. templatetag:: get_static_prefix
|
.. templatetag:: get_static_prefix
|
||||||
|
|
||||||
|
@ -2395,7 +2396,7 @@ into the template, you can use the :ttag:`get_static_prefix` template tag
|
||||||
instead::
|
instead::
|
||||||
|
|
||||||
{% load static %}
|
{% load static %}
|
||||||
<img src="{% get_static_prefix %}images/hi.jpg" />
|
<img src="{% get_static_prefix %}images/hi.jpg" alt="Hi!" />
|
||||||
|
|
||||||
There's also a second form you can use to avoid extra processing if you need
|
There's also a second form you can use to avoid extra processing if you need
|
||||||
the value multiple times::
|
the value multiple times::
|
||||||
|
@ -2403,8 +2404,8 @@ the value multiple times::
|
||||||
{% load static %}
|
{% load static %}
|
||||||
{% get_static_prefix as STATIC_PREFIX %}
|
{% get_static_prefix as STATIC_PREFIX %}
|
||||||
|
|
||||||
<img src="{{ STATIC_PREFIX }}images/hi.jpg" />
|
<img src="{{ STATIC_PREFIX }}images/hi.jpg" alt="Hi!" />
|
||||||
<img src="{{ STATIC_PREFIX }}images/hi2.jpg" />
|
<img src="{{ STATIC_PREFIX }}images/hi2.jpg" alt="Hello!" />
|
||||||
|
|
||||||
.. templatetag:: get_media_prefix
|
.. templatetag:: get_media_prefix
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue