зеркало из https://github.com/mozilla/bedrock.git
79 строки
3.0 KiB
ReStructuredText
79 строки
3.0 KiB
ReStructuredText
.. This Source Code Form is subject to the terms of the Mozilla Public
|
|
.. License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
.. file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
|
|
.. _download-buttons:
|
|
|
|
========================
|
|
Firefox Download Buttons
|
|
========================
|
|
|
|
There are two Firefox download button helpers in bedrock to choose from. The first is a lightweight button
|
|
that links directly to the ``/firefox/download/thanks/`` page. Its sole purpose is to facilitate downloading
|
|
the main release version of Firefox.
|
|
|
|
.. code-block:: jinja
|
|
|
|
{{ download_firefox_thanks() }}
|
|
|
|
The second type of button is more heavy weight, and can be configured to download any build of Firefox (e.g.
|
|
Release, Beta, Developer Edition, Nightly). It can also offer functionality such as direct (in-page) download
|
|
links, so it comes with a lot more complexity and in-page markup.
|
|
|
|
.. code-block:: jinja
|
|
|
|
{{ download_firefox() }}
|
|
|
|
Which button should I use?
|
|
--------------------------
|
|
|
|
A good rule of thumb is to always use ``download_firefox_thanks()`` for regular landing pages (such as
|
|
``/firefox/new/``) where the main release version of Firefox is the product being offered. For pages pages
|
|
that require direct download links, or promote pre-release products (such as ``/firefox/channel/``)
|
|
then ``download_firefox()`` should be used instead.
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
See `helpers.py`_ for documentation and supported parameters for both buttons.
|
|
|
|
.. _helpers.py: https://github.com/mozilla/bedrock/blob/master/bedrock/firefox/templatetags/helpers.py
|
|
|
|
External referrers
|
|
------------------
|
|
|
|
Generally we encourage other websites in the Mozilla ecosystem to link to the `/firefox/new/`_ page when
|
|
prompting visitors to download Firefox, since it provides a consistent user experience and also benefits
|
|
SEO. In some circumstances however sites may want to provide a download button that initiates a file
|
|
download automatically when clicked. For cases like this, sites can link to the following URL:
|
|
|
|
.. code-block::
|
|
|
|
https://www.mozilla.org/firefox/download/thanks/?s=direct
|
|
|
|
.. Important::
|
|
|
|
Including the ``s=direct`` query parameter here will ensure that Windows download attribution is
|
|
collected and recorded correctly in Telemetry. Also, make sure to **not** include the locale in
|
|
the URL, so that bedrock can serve the most suitable language based on the visitor's browser
|
|
preference.
|
|
|
|
.. Note::
|
|
|
|
This download URL will not automatically trigger a download in older Internet Explorer browsers. If
|
|
that's important to your visitors, then you can use a `conditional comment`_ to provide a different link.
|
|
|
|
.. code-block:: html
|
|
|
|
<!--[if !IE]><!-->
|
|
<a href="https://www.mozilla.org/firefox/download/thanks/?s=direct">Download Firefox</a>
|
|
<!--<![endif]-->
|
|
|
|
<!--[if IE]>
|
|
<a href="https://www.mozilla.org/firefox/new/">Download Firefox</a>
|
|
<![endif]-->
|
|
|
|
.. _/firefox/new/: https://www.mozilla.org/firefox/new/
|
|
.. _conditional comment: https://en.wikipedia.org/wiki/Conditional_comment
|
|
|