Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
b243659
Add upgrade consideration note for IMAGE_COMPRESSION_QUALITY
gasman Jun 23, 2015
c71a5e4
remove IN DEVELOPMENT from 1.0 release notes
gasman Jun 24, 2015
f59f8a5
minor docs readme change
Jun 23, 2015
b9640a9
Changed lots of things in docs. Just snippets to go
Jun 24, 2015
81bfe0f
minor fixes post review
Jun 25, 2015
3303db8
Added snippets section
Jun 25, 2015
aed0e13
Improvements to RoutablePage docs
kaedroho Jun 19, 2015
0135ddb
Move the two RemovedInWagtail11Warnings to Wagtail 1.2 instead.
gasman Jun 23, 2015
4871774
Remove "Documentation currently incomplete and in draft status" note …
gasman Jun 30, 2015
e77b98b
Fetch translations from transifex
gasman Jun 30, 2015
f2e89a0
Add new translators to CONTRIBUTORS.rst
gasman Jun 29, 2015
13a1abd
Merge pull request #1455 from gasman/translations-1.0rc2-take2
kaedroho Jun 30, 2015
5e52a78
Support serialising StreamValue in wagtailapi - fixes #1454
gasman Jun 30, 2015
1fff180
Test foreign key representation in streamfield
kaedroho Jul 2, 2015
4626fd9
Version bump to 1.0rc2
gasman Jul 3, 2015
d360e05
Code fixes and clarifications for tutorial - fixes #1473
gasman Jul 7, 2015
34a080b
de-capitalise 'Body field'
gasman Jul 7, 2015
f83f843
Merge pull request #1487 from gasman/fix/tutorial-newtemplate
tomdyson Jul 7, 2015
fcc9b96
moved upgrade_notify from incorrect location
Jul 7, 2015
0282ff0
Prepare for 1.0 release
gasman Jul 9, 2015
b77cdd2
Ensure that tabs in non-Latin languages are given non-blank IDs - fix…
gasman Jul 14, 2015
8dbd51a
Merge pull request #1516 from gasman/fix/unicode-slugify
kaedroho Jul 15, 2015
3702b71
Documentation fix - renditions do not provide 'alt' (#1517)
gasman Jul 15, 2015
bce3fe8
Add upgrade consideration note for version upgrade notifications
gasman Jul 15, 2015
4ff07b9
'extremely basic information' -> 'the hostname of your Wagtail site'
gasman Jul 15, 2015
581be6a
Merge pull request #1519 from gasman/docs/update-notifications-releas…
tomdyson Jul 15, 2015
702ac15
version 1.0 (for real this time)
gasman Jul 16, 2015
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Changelog
=========

1.0 (xx.xx.xxxx)
1.0 (16.07.2015)
~~~~~~~~~~~~~~~~

* Added StreamField, a model field for freeform page content
Expand Down Expand Up @@ -58,7 +58,7 @@ Changelog
* Added `AUTO_UPDATE` flag to search backend settings to enable/disable automatically updating the search index on model changes
* Made the built-in project template follow the Django one, with several Wagtail-specific additions. The template comes with two apps (home and search)
* `with_metaclass` is now imported from Django's bundled copy of the `six` library, to avoid errors on Mac OS X from an outdated system copy of the library being imported
* Added new translations for Croatian and Finnish
* Added new translations for Croatian, Finnish and Hebrew (Israel)


0.8.8 (18.06.2015)
Expand Down
5 changes: 3 additions & 2 deletions CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,10 @@ Translators
* Finnish: Glen Somerville
* French: Sylvain Fankhauser, sephii, Adrihein, Bertrand Bordage, Romain Hardouin, linibou, nahuel, Benoît Bar
* Galician: fooflare, fonso
* German: Karl Sander, Johannes Spielmann, m0rph3u5, pcraston
* German: Karl Sander, Johannes Spielmann, m0rph3u5, pcraston, Tammo van Lessen
* Greek: Serafeim Papastefanos, Jim Dal
* Italian: Andrea Tagliazucchi, Claudio Bantaloukas
* Hebrew (Israel): bjesus, Lior Abazon
* Italian: Andrea Tagliazucchi, Claudio Bantaloukas, Alessio Di Stasio, Giacomo Ghizzani
* Japanese: Daigo Shitara, Toshikazu Michisu
* Mongolian: Delgermurun Purevkhuu, miiiga
* Polish: Łukasz Bołdys
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

These are Sphinx docs, automatically built at http://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Wagtail's development requirements (in the root Wagtail directory):

pip install requirements-dev.txt
pip install -r requirements-dev.txt

To build the documentation for browsing, from this directory run:

Expand Down
Binary file modified docs/_static/images/screen02_dashboard_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/screen03_explorer_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/screen04_search_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/screen05_explorer_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/screen09_page_type_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/screen10_blank_page_edit_screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/screen11.6.5_images.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/images/screen11_rich_text_field.png
Binary file not shown.
Binary file modified docs/_static/images/screen12_edit_screen_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/images/screen14_add_carousel_button.png
Binary file not shown.
Binary file added docs/_static/images/screen14_add_main_image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/screen20_insert_video_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/screen26.5_promote_tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/images/screen32_image_edit_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/screen33_snippet_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/advanced_topics/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Wagtail update notifications

WAGTAIL_ENABLE_UPDATE_CHECK = True

For admins only, Wagtail performs a check on the dashboard to see if newer releases are available. This also provides the Wagtail team with extremely basic information about where Wagtail is in use. If you'd rather not receive update notifications, or if you'd like your site to remain unknown, you can disable it with this setting.
For admins only, Wagtail performs a check on the dashboard to see if newer releases are available. This also provides the Wagtail team with the hostname of your Wagtail site. If you'd rather not receive update notifications, or if you'd like your site to remain unknown, you can disable it with this setting.


Private Pages
Expand Down
5 changes: 4 additions & 1 deletion docs/editor_manual/documents_images_snippets/documents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,7 @@ Documents such as PDFs can be managed from the Documents interface, available in

* When editing a document you can replace the file associated with that document record. This means you can update documents without having to update the pages on which they are placed. Changing the file will change it on all pages that use the document.
* Add or remove tags using the Tags field.
* Save or delete documents using the buttons at the bottom of the interface. **NOTE:** deleted documents cannot be recovered.
* Save or delete documents using the buttons at the bottom of the interface.

.. Warning::
Deleted documents cannot be recovered.
20 changes: 18 additions & 2 deletions docs/editor_manual/documents_images_snippets/images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,25 @@ If you want to edit, add or remove images from the CMS outside of the individual

.. image:: ../../_static/images/screen31_images_page.png

* Clicking an image will allow you to edit the data associated with it. This includes the Alt text, the photographers credit, the medium of the subject matter and much more. **NOTE:** changing the alt text here will alter it for all occurrences of the image in carousels, but not in inline images, where the alt text can be set separately.
* Clicking an image will allow you to edit the data associated with it. This includes the Alt text, the photographers credit, the medium of the subject matter and much more.

.. Warning::
Changing the alt text here will alter it for all occurrences of the image in carousels, but not in inline images, where the alt text can be set separately.

.. image:: ../../_static/images/screen32_image_edit_page.png

* When editing an image you can replace the file associated with that image record. This means you can update images without having to update the pages on which they are placed. Changing the file will change it on all pages that use the image.
Changing the image
__________________

* When editing an image you can replace the file associated with that image record. This means you can update images without having to update the pages on which they are placed.

.. Warning::
Changing the file will change it on all pages that use the image.

Focal point
___________

* This interface allows you to select a focal point which can effect how your image displays to visitors on the front-end.
* If your images are cropped in some way to make them fit to a specific shape, then the focal point will define the centre point from which the image is cropped.
* To set the focal point, simply a marquee around the most important element of the image.
* If the feature is set up in your website, then on the front-end you will see the crop of this image focusing on your selection.
37 changes: 32 additions & 5 deletions docs/editor_manual/documents_images_snippets/snippets.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,38 @@
Snippets
~~~~~~~~

.. note::
Documentation currently incomplete and in draft status
Snippets allow you to create elements on a website once and reuse them in multiple places. Then, if you want to change something on the snippet, you only need to change it once, and it will change across all the occurances of the snippet.

.. UNSURE HOW TO WRITE THIS AS THE ADVERT EXAMPLE IN WAGTAIL DEMO IS NOT A PARTICULARLY HELPFUL USE CASE.
How snippets are used can vary widely between websites. Here are a few examples of things Torchbox have used snippets for on our clients websites:

When creating a page on a website, it is a common occurrence to want to add in a piece of content that already exists on another page. An example of this would be a person's contact details, or an advert that you want to simply show on every page of your site, without having to manually apply it.
* For staff contact details, so that they can be added to many pages but managed in one place
* For Adverts, either to be applied sitewide or on individual pages
* To manage links in a global area of the site, for example in the footer
* For Calls to Action, such as Newsletter signup blocks, that may be consistent across many different pages

Wagtail makes this easy with Snippets.
The Snippets menu
-----------------

.. image:: ../../_static/images/screen33_snippet_menu.png

* You can access the Snippets menu by clicking on the 'Snippets' link in the left-hand menu bar.
* To add or edit a snippet, click on the snippet type you are interested in (often help text will be included to help you in selecting the right type)
* Click on an individual snippet to edit, or click 'Add ...' in the top right to add a new snippet

.. Warning::
Editing a snippet will change it on all of the pages on which it has been used. In the top-right of the Snippet edit screen you will see a label saying how many times the snippet has been used. Clicking this label will display a listing of all of these pages.

.. image:: ../../_static/images/screen34_snippet_used_times.png

Adding snippets whilst editing a page
-------------------------------------

If you are editing a page, and you find yourself in need of a new snippet, do not fear! You can create a new one without leaving the page you are editing:

* Whilst editing the page, open the snippets interface in a new tab, either by Ctrl+click (cmd+click on Mac) or by right clicking it and selecting 'Open in new tab' from the resulting menu.
* Add the snippet in this new tab as you normally would.
* Return to your existing tab and reopen the Snippet chooser window.
* You should now see your new snippet, even though you didn't leave the edit page.

.. Note::
Even though this is possible, it is worth saving your page as a draft as often as possible, to avoid your changes being lost by navigating away from the edit page accidentally.
3 changes: 0 additions & 3 deletions docs/editor_manual/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
Using Wagtail: an Editor's guide
================================

.. note::
Documentation currently incomplete and in draft status

This section of the documentation is written for the users of a Wagtail-powered site. That is, the content editors, moderators and administrators who will be running things on a day-to-day basis.

.. toctree::
Expand Down
57 changes: 52 additions & 5 deletions docs/editor_manual/new_pages/creating_body_content.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,39 @@
Creating page body content
~~~~~~~~~~~~~~~~~~~~~~~~~~

The majority of the body content within a page will be created within text fields.
Wagtail supports a number of basic fields for creating content, as well as our unique StreamField feature which allows you to construct complex layouts by combining these basic fields in any order.

There are two types of text entry fields you will see when creating a page. Some, like *Page title* are basic text fields come with no formatting options. This is because all titles display the same across a single page type. Others, *Body* for example, require more formatting, and so a set of tools are provided for this purpose. These are referred to as rich text fields.
===========
StreamField
===========

So, when you click into certain fields, for example the *Body* field, you will be presented with a set of tools which allow you to format and style your text. These tools also allow you to insert links, images, videos clips and links to documents.
StreamField allows you to create complex layouts of content on a page by combining a number of different arrangements of content, 'blocks', in any order.

.. image:: ../../_static/images/screen11_rich_text_field.png
.. image:: ../../_static/images/screen11_empty_streamfield.png

When you first edit a page, you will be presented with the empty StreamField area, with the option to choose one of several block types. The block types on your website may be different from the screenshot here, but the principles are the same.

Click the block type, and the options will disappear, revealing the entry field for that block.

Depending on the block you chose, the field will display differently, and there might even be more than one field! There are a few common field types though that we will talk about here.

* Basic text field
* Rich text field
* Image field

Basic text field
================

Basic text fields have no formatting options. How these display will be determined by the style of the page in which they are being inserted. Just click into the field and type!

Rich text fields
================

Most of the time though, you need formatting options to create beautiful looking pages. So some fields, like the fields in the 'Paragraph block' shown in the screenshot, have many of the options you would expect from a word processor. These are referred to as rich text fields.

So, when you click into one of these fields, you will be presented with a set of tools which allow you to format and style your text. These tools also allow you to insert links, images, videos clips and links to documents.

.. image:: ../../_static/images/screen11.1.5_streamfield_richtext.png

Below is a summary of what the different buttons represent:

Expand Down Expand Up @@ -37,4 +63,25 @@ Below is a summary of what the different buttons represent:

.. image:: ../../_static/images/screen11.7_links_docs.png

**Insert link / document:** Allows you to insert a link or a document into the rich text field. See Inserting links and Inserting documents for more details. See `Inserting links section <inserting_links.html>`.
**Insert link / document:** Allows you to insert a link or a document into the rich text field. See Inserting links and Inserting documents for more details. See `Inserting links section <inserting_links.html>`.

Adding further blocks in StreamField
==============================================

.. image:: ../../_static/images/screen11.8_adding_new_blocks.png

* To add new blocks, click the '+' icons above or below the existing blocks.
* You'll then be presented once again with the different blocks from which you may choose.
* You can cancel the addition of a new block by clicking the cross at the top of the block selection interface.

Reordering and deleting content in StreamField
==============================================

.. image:: ../../_static/images/screen11.9_streamfield_reordering.png

* Click the arrows on the right-hand side of each block to move blocks up and down in the StreamField order of content.
* The blocks will be displayed in the front-end in the order that they are placed in this interface.
* Click the rubbish bin on the far right to delete a field

.. Warning::
Once a StreamField field is deleted it cannot be retrieved if the page has not been saved. Save your pages regularly so that if you acidentally delete a field you can reload the page to undo your latest edit.
2 changes: 1 addition & 1 deletion docs/editor_manual/new_pages/inserting_documents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Inserting links to documents into body text

.. image:: ../../_static/images/screen27_docs_icon.png

It is possible to insert links to documents held in the CMS into the body text of a web page by clicking the button above in the Body field.
It is possible to insert links to documents held in the CMS into the body text of a web page by clicking the button above in the rich text field.

The process for doing this is the same as when inserting an image. You are given the choice of either choosing a document from the CMS, or uploading a new document.

Expand Down
38 changes: 15 additions & 23 deletions docs/editor_manual/new_pages/inserting_images.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,16 @@
Inserting images and videos in a page
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There will obviously be many instances in which you will want to add images to a page. There may be multiple ways in which to add an image to a page, depending on the setup of the site that you work on. For example, the Wagtail demo standard page type has two ways to insert images.
There will obviously be many instances in which you will want to add images to a page. There are two main ways to add images to pages, either via a specific image chooser field, or via the rich text field image button. Which of these you use will be dependent on the individual setup of your site.

* In the main carousel, or…
* Within the body of the page
Inserting images using the image chooser field
______________________________________________

Inserting images into the carousel
__________________________________
Often a specific image field will be used for a main image on a page, or for an image to be used when sharing the page on social media. For the standard page on Torchbox.com, the former is used.

The carousel is where the main, featured images and videos associated with a page should be displayed.
.. image:: ../../_static/images/screen14_add_main_image.png

.. image:: ../../_static/images/screen14_add_carousel_button.png

* To insert a carousel item click the Add carousel content link in the Carousel content section.

.. image:: ../../_static/images/screen15_carousel_form.png

* You can then insert an image by clicking the *Choose an image* button.
* It is also possible to add videos to a carousel. Simply copy and paste the web address for the video (either YouTube or Vimeo) into the *Embed URL* field and click Insert. A poster image for the video can also be uploaded or selected from the CMS. This is the image displayed before a user has clicked play on the video.
* The *Caption* field allows you to enter a caption to be displayed with your image. This caption also acts as the 'Alternative text' or Alt text for your image. This is a small piece of invisible code that is used by screen readers that enable visually impaired users to hear a description of the image.
* The external link field allows you to enter a web address for pages not within your website.
* Or you can select an internal page using the page chooser (see below for info on the page chooser).
* You can add more items into the same carousel by clicking the Add carousel content link again. Please see Adding multiple items section below for help with removing or ordering carousel items.
* You insert an image by clicking the *Choose an image* button.

Choosing an image to insert
___________________________
Expand Down Expand Up @@ -53,20 +41,24 @@ The image below demonstrates finding and inserting an image that is already pre
#. This *Tags* allows you to associate tags with the image you are uploading. This allows them to be more easily found when searching. Each tag should be separated by a space. Good practice for creating multiple word tags is to use an underscore between each word (e.g. western_yellow_wagtail).
#. Click *Upload* to insert the uploaded image into the carousel. The image will also be added to the main CMS image library for reuse in other content.

Inserting images into the body text
___________________________________
Inserting images using the rich text field
__________________________________________

.. image:: ../../_static/images/screen11.6.5_images.png

Images can also be inserted into the body text of a page. When editing the Body field of a standard page, click the image illustrated above. You will then be presented with the same options as for inserting images into the main carousel.
Images can also be inserted into the body text of a page via the rich text editor. When working in a rich text field, click the image illustrated above. You will then be presented with the same options as for inserting images into the main carousel.

In addition, the Wagtail Demo site allows you to chose an alignment for you image.
In addition, Wagtail allows you to chose an alignment for you image.

.. image:: ../../_static/images/screen18_image_alignment.png

#. You can select how the image is displayed by selecting one of the format options.
#. In the Wagtail Demo site, images inserted into the body text do not have embedded captions (these should be added as regular body text). However you must still provide specific alt text for your image.
#. You must provide specific alt text for your image.

The alignments available are described below:

* **Full width:** Image will be inserted using the full width of the text area.
* **Half-width left/right aligned:** Inserts the image at half the width of the text area. If inserted in a block of text the text will wrap around the image. If two half-width images are inserted together they will display next to each other.

.. Note::
The display of images aligned in this way is dependent on your implementation of Wagtail, so you may get slightly different results.
Loading