mirror
/
wagtail
kopia lustrzana https://github.com/wagtail/wagtail
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
7 369 Commity
55 Gałęzie
256 Tagi
3,4 GiB
Wykres commitów

158 Commity (c043049bb62414ab46ab956cf13b961f94b6167c)

Autor SHA1 Wiadomość Data
David Burke db54a9f0c4 Update IntegerBlock docs to show correct kwargs (#2930) 
It should be max and min value - not length. See [here](07c3ba84fb/wagtail/wagtailcore/blocks/field_block.py (L306)).

So this would work 

`blocks.IntegerBlock(max_value=10, min_value=0)`

but this wouldn't do anything

`blocks.IntegerBlock(max_length=10, min_length=0)`
 2016-08-20 02:38:00 +01:00
Matt Westcott bc7739e104 Add usage examples for EmailBlock, IntegerBlock, DecimalBlock 
Thanks to @OktayAltay for the original pull request.
 2016-08-08 20:15:45 +01:00
Nik Nyby 389317c104 docs: fix typo (#2845) 2016-07-15 21:58:47 +03:00
Matt Westcott be1e1927c5 Promote include_block and unicode page slugs to major features 2016-07-07 11:20:43 +01:00
Matt Westcott dbc4c9b28e Adds the include_block template tag (#2786) 
Update render and render_basic methods on Block to take a context kwarg

Update TableBlock to support passing extra context to render

Implement render_as_block on BoundBlock, StreamValue and StructValue.

Collectively, these are the objects encountered during template rendering which typically render
a block template when output inside {{ ... }} tags. Implementing render_as_block allows us to do
the same thing, but passing a template context as well.

Implement include_block tag

Support extra context vars on include_block via 'with foo=bar'

Support 'only' flag on include_block tag, to omit the parent context

Update StreamField documentation to cover the include_block tag

Rewrite 'BoundBlocks and values' docs based on the include_block tag

Add tests for blocks with legacy render / render_basic methods

Any bits of StreamField infrastructure that attempt to call render or render_basic
on a block with a 'context' kwarg, should (for now) also work on blocks that don't
accept the context kwarg, but output a RemovedInWagtail18Warning.

Explicitly test whether render / render_basic will accept a 'context' kwarg

This avoids unexpected behaviour when the method legitimately accepts a context
kwarg, but happens to throw an unrelated TypeError - in this situation, the final
output (or error diagnostics) will behave as if the context was never passed,
making debugging difficult. See https://github.com/torchbox/wagtail/pull/2786#discussion_r69563984
 2016-07-06 17:44:02 +03:00
Matt Westcott 9961455c6a Add formal support for customising the form rendering of StructBlocks 
The `form_template` attribute was mentioned in passing in the docs, but was missing various things
to make it fully useful:

- context passed to form_template now includes 'prefix' and 'block_definition'
- context for the form is now populated in a separate overrideable `get_form_context` method
- full documentation and tests for form_template and get_form_context added
 2016-07-05 11:48:09 +01:00
Matt Westcott 5758b54f2e Support `error_messages` dict as argument to RegexBlock 
The individual `error_message` kwarg on RegexField is deprecated in Django 1.8
(and removed in Django 1.10), so it's appropriate for RegexBlock to follow the
same convention.
 2016-06-28 16:11:52 +01:00
OktayAltay 9358e3b611 Add new FloatBlock, DecimalBlock and a RegexBlock (#2737) 2016-06-23 10:14:28 +01:00
Oktay Altay 31ce2e802c Add new EmailBlock and IntegerBlock 2016-06-17 23:39:49 +01:00
Gagaro 871a5b5d9c Use python_2_unicode_compatible in snippets.rst (#2688) 
We should use `python_2_unicode_compatible` in the documentation so that new users know the best practice.
 2016-06-07 13:49:28 +01:00
Josh Schneier 6d1a9efbb6 Update documentation and code to put mixin first 2016-05-04 14:05:33 +01:00
Robert Rollins 11793f88c5 Changed indentation on all code samples to 4 spaces. 
Most of the samples were already 4-space indented, but a few were using 2-space,
which is both inconsistent and, when it happened with Python code samples,
incompatible with PEP8.
 2016-04-28 10:57:22 +01:00
João Luiz Lorencetti ffbe4730f0 The destination of the ParentalKey should be a subclass of ClusterableModel 2016-04-03 20:18:57 +01:00
Timo Rieber 9bdc843c8f Clarified wagtail userbar options and positioning 2016-03-27 14:23:47 +01:00
Tim Heap 6bd168580e Change Indexed.search_fields to be a listish thing 
Indexed.search_fields used to be a tuple. This is incorrect, and it
should have been a list.  Changing it to be a list now would be a
backwards incompatible change, as people do

    search_fields = Page.search_fields + (
        SearchField('body')
    )

Adding a tuple to the end of a list causes an error, so this would
cause all old code that used tuples to throw an error. This is not
great.

A new ThisShouldBeAList class, which subclasses list, has been added.
It additionally allows tuples to be added to it, as in the above
behaviour, but will raise a deprecation warning if someone does this.
Old code that uses tuples will continue to work, but raise a deprecation
warning.

See #2310
 2016-03-24 21:05:09 +00:00
Robert Rollins b94ff6a952 Searchly no longer supports Elasticsearch 1.x, so I switched the suggested development service to Bonsai. 2016-03-10 15:11:42 +00:00
Robert Rollins 6446c42132 Various typo fixes and grammar/clarity improvements. 2016-03-10 15:11:41 +00:00
Loïc Teixeira 33aad3957f Fix internal links with anchors 
Generating links with `link text <./path/to/doc#anchor>`__ does not work for html.
It produces a link to `./path/to/doc#anchor` instead of `./path/to/doc.html#anchor`.

It would be tempting to add `.html` before `#` but would likely cause some more issues
when generating the documentation as pdf or epub.

References on the other hand will work regardless of the output format.
 2016-03-06 21:05:05 +00:00
Matt Westcott 49e2de9813 fix doc rendering error in wagtailuserbar code block 2016-03-06 21:02:51 +00:00
Josh Barr a1a2940495 fixed font size rounding issue in firefox, added contrib notes 2016-03-03 12:29:28 +13:00
Quadric d27df01815 Tagging snippets documentation fix 
I'm not sure i'm right but i think there is a typo in this example. I guess there should be a AdvertTag use in TaggableManager instead BlogPageTag
 2016-02-12 11:11:08 +00:00
Andrew Pryde e2601c30b8 Fix PageQuerySet code overriding code snippet 2016-02-08 16:03:11 +03:00
Karl Hobley 95ff74feeb Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
Karl Hobley 8a9e65f92f Change title of "topics" section to "Usage guide" 2016-01-27 11:27:16 +00:00
Matt Westcott 04fdd5f352 Remove Django 1.7 support from documentation, requirements and CI definitions 2016-01-05 17:38:29 +00:00
Denis Voskvitsov ab45915a90 Set `request.is_preview` flag to show whether page is served as preview 2015-12-16 11:28:53 +00:00
Tim Heap 9e8c2c2d5f Allow custom Page Managers 
Previously, if a developer wanted to use a custom Manager on their Page
subclass, some fairly hacky hacks were required. Now, the `objects`
attribute is only overridden if it is a plain `Manager`. If it is
anything else, it is left alone. A system check has been added to ensure
that all `Page` managers inherit from `PageManager`
 2015-12-14 23:09:45 +00:00
Matt Westcott 9e124cb9b6 Remove use of value.bound_blocks from basic StructBlock template example. 
This hasn't been necessary since #1360 was merged, and the new 'BoundBlocks and values' section covers it much better.
 2015-12-11 12:48:37 +00:00
Matt Westcott 0e34282646 Add section about BoundBlocks and values 2015-12-11 12:48:37 +00:00
Matt Westcott 2c765a7462 Release note for #1491 2015-12-11 12:46:01 +00:00
Karl Hobley eed5c60d72 Docs for index.RelatedFields 2015-12-11 12:29:27 +00:00
Maris Serzans 32b4124767 Changed verbose names to start with lowercase when necessary 2015-12-08 17:33:19 +00:00
Jan Korte 56cfe02bae snippet docs: loading the tags is necessary 2015-12-03 18:45:29 +00:00
Tim Heap f4968de0f9 Allow overriding attributes in {% image %} tag 
The `alt` attribute that was automatically generated as part of the
`{% image %}` tag could not be overridden. If template authors passed
their own `alt="..."` attribute in, two would be printed out instead
of the default one being overridden.

The relevant code has been refactored to build a dict of attributes,
allowing the default set to be overridden, and then printing them using
`flatatt`.

Fixes #1933
 2015-11-24 11:38:10 +00:00
Rich Brennan 010838b53e Add Orderable to list of imported wagtailcore models 2015-11-24 10:36:02 +00:00
Rich Brennan fab4e2224f Move content_panels inside BookPage definition. 2015-11-24 10:36:02 +00:00
Karl Hobley 059fc15b9d Added note about Elasticsearch 2.x 2015-11-20 12:50:31 +00:00
Rich Brennan 2ad3985d67 Move content_panels inside BlogPage definition. 2015-11-19 17:16:02 +00:00
Matt Westcott c73a3caa31 Use rendition.alt in `{% image img as rendition %}` example. 
This restores the documentation to the pre-#1517 state, and is evidently more natural to write since the original documentation did so by mistake :-)
 2015-11-19 15:29:40 +00:00
Alex Gleason 6a0b576376 Updated reasoning for Page suffix, fixes #1927 
Fixed typo
 2015-11-16 20:06:36 +00:00
Matt Westcott f668922893 Add a can_choose_root flag to PageChooserBlock 2015-11-02 15:12:42 +00:00
Matt Westcott 2eb4b4c2c1 Release notes for #1810, #1835, #1812 2015-10-20 11:16:09 +01:00
Karl Hobley 26889ba128 Merge pull request #1812 from gasman/feature/block-template-context 
Allow block subclasses to pass extra context variables to templates
 2015-10-19 09:29:59 +01:00
Matt Westcott c1edbe6a98 Merge branch 'docs-self-var' of https://github.com/kaedroho/wagtail into kaedroho-docs-self-var 2015-10-14 14:52:00 +01:00
Matt Westcott c2a183f19f Documentation tweaks as per https://github.com/torchbox/wagtail/pull/1815#commitcomment-13736415 https://github.com/torchbox/wagtail/pull/1815#commitcomment-13736421 2015-10-13 15:17:47 +01:00
Karl Hobley b278a0c0f8 Docs for custom ordering 2015-10-13 10:06:58 +01:00
Karl Hobley 6eae465e64 Renamed "self" template variable to "page" in docs 2015-10-13 09:52:16 +01:00
Matt Westcott 06e721bc74 document the 'operator' kwarg on QuerySet.search 2015-10-12 22:04:29 +01:00
Matt Westcott 46845112e2 Allow block subclasses to pass extra context variables to templates 
Block now defines a get_context method, which subclasses can override
in the same way as we can for pages.
 2015-10-12 13:25:56 +01:00
Karl Hobley 4dbf166e06 Merged duplicate documentation 2015-10-12 12:20:45 +01:00
Karl Hobley 83f8332288 Added docs for search operators 2015-10-12 12:15:57 +01:00
Karl Hobley fb09d89ec6 Search docs improvements 2015-10-12 12:15:33 +01:00
Matt Westcott 94d0d7bda2 Release / upgrade consideration note for #1478 2015-10-07 20:02:25 +01:00
Matt Westcott 94b5975afa Document the new image/document queryset search method 2015-10-07 20:02:19 +01:00
Karl Hobley 4dc09dfb22 Merge pull request #1755 from takeflight/feature/jinja2-template-functions 
Add rudimentary Jinja2 template tag support
 2015-10-06 22:00:47 +01:00
Matt Westcott 3cbee6c66c fix typo I introduced while removing typos 2015-10-05 21:12:21 +01:00
Matt Westcott 7d67e4b448 Minor copyediting on the Pages docs 2015-10-05 21:07:09 +01:00
Karl Hobley be0a2ccd1c Tweaks to template rendering docs 2015-10-05 21:07:09 +01:00
Karl Hobley f72e84f199 Added a couple of missing links 2015-10-05 21:07:09 +01:00
Karl Hobley c18c67ba3b Working with pages docs 2015-10-05 21:07:09 +01:00
Karl Hobley 2e65c08210 Docs for inline models 2015-10-05 21:07:09 +01:00
Karl Hobley ee7718ccdb Various tweaks 2015-10-05 21:07:09 +01:00
Karl Hobley 249a411b09 Template rendering docs 2015-10-05 21:07:09 +01:00
Karl Hobley 1b282d49bc Work on "Page models" 2015-10-05 21:07:09 +01:00
Karl Hobley 86c01bdf7b Renamed to "Page models" 
I think this is a good place to add some general usage docs so made the name more generic.
 2015-10-05 21:07:09 +01:00
Karl Hobley 85414a8b54 Fixed headings 2015-10-05 21:07:08 +01:00
Karl Hobley f72b8302f9 Moved "setting up the page editor interface" into topics 2015-10-05 21:07:08 +01:00
Tim Heap bc6b5a8a6c Normalise all code blocks in the docs 
All `.. code::` instances have been changed to use `.. code-block::`,
and have been properly formatted. The syntax names have been normalised,
so all django templates use the `html+django` syntax, shell commands use
`sh`, and plain text uses `text`.
 2015-10-05 16:55:58 +01:00
Tim Heap e225481f2f Add documentation for using Jinja2 2015-10-01 16:00:40 +10:00
Karl Hobley ebd01fd1b4 Merge pull request #1719 from nimasmi/custom-queryset-docs 
Document custom queryset required approach
 2015-09-23 09:52:43 +01:00
Karl Hobley c224002d3e verbose_name should be lowercase 2015-09-23 09:52:26 +01:00
Nick Smith 536c8cd203 Fix typo 2015-09-23 09:42:50 +01:00
Nick Smith dea22d8fe0 Document custom queryset required approach 2015-09-23 09:31:35 +01:00
Dave Cranwell 12fc3e6601 Fixes #1600. Adds documentation and caveats about image formats system within rich text 2015-09-21 14:01:18 +01:00
Matt Westcott 38e939b5a8 Merge pull request #1676 from nimasmi/page-ordering-docs 
Document ineffectiveness of specifying `Page._meta.ordering`
 2015-09-14 20:26:52 +01:00
Nick Smith db14a1dcf4 Document ineffectiveness of specifying `Page._meta.ordering` 2015-09-11 16:40:23 +01:00
Matt Westcott e60e57016e Merge branch 'bug/tagged-snippets' of https://github.com/takeflight/wagtail into takeflight-bug/tagged-snippets 
Conflicts:
	docs/topics/snippets.rst
 2015-09-03 12:18:25 +01:00
Matt Westcott 2ed16e3ee2 Update documentation to indicate that SnippetChooserPanel no longer requires a snippet_type argument 2015-08-28 10:57:31 +01:00
Matt Westcott 4353759018 Merge branch 'kaedroho-snippets-search' 
Conflicts:
	CHANGELOG.txt
 2015-08-27 15:42:45 +01:00
Matt Westcott 7751a8439a Release note for #1610 2015-08-27 15:41:32 +01:00
Matt Westcott c9aa44cc7e Add documentation for searchable snippets 2015-08-27 15:29:01 +01:00
Alex Gleason 6675a738e4 Added comment for Python 2 2015-08-24 18:15:16 -05:00
Tim Heap 537502b521 Add documentation for tagging snippets 2015-08-24 10:22:02 +10:00
Alex Gleason e09acbea2d Changed __unicode__ to __str__ 2015-08-20 22:30:55 -05:00
Marc 3b651241ae Fixed indentation problems 
The original indentation used was 2 spaces. Fixed to 4 spaces.
 2015-08-17 12:49:54 +02:00
Matt Westcott bd59ee93b6 Release note for #1490 2015-08-01 11:13:46 +02:00
Matt Westcott 55c3606b16 Merge branch 'es-index-atomic-rebuild' of https://github.com/kaedroho/wagtail into kaedroho-es-index-atomic-rebuild 2015-08-01 10:52:20 +02:00
Karl Hobley 459a8c8b44 Renamed searchpicks app to searchpromotions 2015-07-21 13:37:42 +01:00
Karl Hobley 669c7ac34c Docs for searchpicks module 2015-07-21 13:37:42 +01:00
Matt Westcott b6b75ba65d Documentation fix - renditions do not provide 'alt' (#1517) 2015-07-15 11:33:21 +01:00
Karl Hobley a2f3c79b98 Docs for atomic rebuild 2015-07-08 15:59:14 +01:00
Karl Hobley 60e2d81052 Use search backend module imports in the docs 2015-07-01 14:36:50 +01:00
Matt Westcott 9bbbe53223 update docs for #1255 2015-06-26 16:34:00 +01:00
Karl Hobley 517a0c378f Change heading styles 2015-06-22 10:29:36 +01:00
Karl Hobley f3b2cde5dc Removed contents and heading 2015-06-22 10:28:24 +01:00
Matt Westcott 8bd6d65a20 Support overriding form classname and template within StructBlock 2015-06-16 13:09:33 +01:00
Matt Westcott fddeb4308b Documentation for migrating a RichTextField to StreamField 2015-06-12 20:33:19 +01:00
Karl Hobley 9713250c42 Moved theory doc into reference 2015-06-05 13:54:15 +01:00
Karl Hobley 98692f9bfa Moved snippets to topics 2015-06-02 09:14:20 +01:00
Karl Hobley eec194f154 Added missing "versionadded" 2015-06-01 09:54:17 +01:00