Karl Hobley
2e970f88ea
Changelog and release note for #2451
2016-04-12 06:57:27 +01:00
Tim Heap
31d2d43d5b
Add wagtail.contrib.settings.jinja2tags ( #2451 )
2016-04-12 06:49:32 +01:00
Charlie Hornsby
5cb7ae01f6
FIx incorrect paginator label in example code ( #2468 )
2016-04-10 11:06:51 +01:00
Tomas Olander
10e564b935
Fix site settings docs for setting an icon
...
The "icon-" prefix is automatically added in SettingMenuItem.
Using "icon-placeholder" as suggested would thus result in
the CSS class "icon-icon-placeholder".
2016-04-01 10:50:03 +02:00
Tom Dyson
6dcb433215
CamelCase JavaScript in hooks documentation
2016-03-11 17:19:45 +00:00
Tom Dyson
43cb7f8e83
Hook for adding JS to all admin pages
...
Like insert_editor_js but not just for edit pages.
2016-03-11 17:19:45 +00:00
Matt Westcott
6803075188
Release notes for #1940
2016-03-11 15:43:43 +00:00
Josh Barr
a7d8a7bd4d
added documentation for page listing buttons
2016-03-11 15:43:42 +00:00
Loïc Teixeira
5429c007ad
Fix internal links
2016-03-06 21:05:05 +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
7861c2b492
Add get_site and get_url_parts to the Page model reference docs
2016-03-01 12:11:14 +00:00
Matt Westcott
d1a86c06da
documentation: now with 8.3% more underline
2016-02-29 15:03:28 +00:00
Matt Westcott
3195a5200f
Prevent deletion of collections that are non-empty
...
Since the collections infrastructure itself does not know about the object types that
can exist within collections, this requires a new hook `describe_collection_contents`
to allow collection contents to be discovered.
2016-02-29 13:14:10 +00:00
Matt Westcott
766e2501e4
Implement register_group_permission_panel hook for adding new panels to the group edit form
2016-02-29 13:14:05 +00:00
Tom Dyson
985a987436
Hook for adding CSS to all admin pages
2016-02-25 10:24:54 +02:00
Matt Westcott
d620ce9656
Document the construct_explorer_page_queryset hook
2016-02-12 11:15:13 +00:00
Matt Westcott
cddbc7c4a8
Remove 'versionadded:: 0.7' tags - 0.7 is ancient enough to be irrelevant
2016-02-11 10:53:03 +00:00
Matt Westcott
1677bd5a0d
insert_editor_css no longer provides a mechanism for custom SCSS
2016-02-11 10:53:03 +00:00
Matt Westcott
dc0d18b6a4
Reorganise Hooks reference into meaningful sections
2016-02-11 10:53:03 +00:00
Tim Heap
224f3f5c37
Remove final references to django-compressor
...
* Remove references from docs
* Fix comment in SCSS files, and fix related variable names
* Remove COMPRESS_ENABLED setting from tests
2016-02-09 18:41:56 +00:00
Matt
999e06af27
Fix parameter name on signal handler
2016-02-04 22:22:12 +00:00
Chris Rogers
5e589d6376
Minor adjustment to settings docs
2016-02-04 22:18:55 +00:00
Mitchel Cabuloy
d09d403d54
Fix frontend cache code example
2016-01-31 13:21:57 +08:00
Karl Hobley
13217dd6ef
WAGTAILAPI_MAX_RESULTS is actually called WAGTAILAPI_LIMIT_MAX
...
Fixes #2156
2016-01-27 11:21:06 +00:00
Matt Westcott
097f45f20b
Fix Page model recipes to pass 'self' as the page object ('page' is undefined)
2016-01-22 11:24:41 +00:00
Matt Westcott
88d1977d34
Document site_name
attribute of Site - fixes #2099
2016-01-13 12:49:46 +00:00
Matt Westcott
04fdd5f352
Remove Django 1.7 support from documentation, requirements and CI definitions
2016-01-05 17:38:29 +00:00
Liam Brenner
b0f4d50aac
Minor documentation fixes for signal handlers
2016-01-05 10:29:20 +00:00
Karl Hobley
9d3e068b0c
Use Django 1.8 TEMPLATES setting in settings doc
...
Also, the ``request`` context processor is now in the defaults
2015-12-16 09:29:17 +00:00
Ben Kerle
3ef94d60a2
Documentation for admin search area hook
2015-12-14 21:21:45 +00:00
Maris Serzans
32b4124767
Changed verbose names to start with lowercase when necessary
2015-12-08 17:33:19 +00:00
Rich Brennan
11618f0c3d
Update content_panels and promote_panels.
...
If I'm right, the Echoer content_panels and promote_panels can be removed as they're defined on Page?
2015-12-03 18:55:01 +00:00
Tim Heap
0071d85aa0
Add Page methods can_move_to
and can_create_at
...
These two tests are used when checking if a new page type can be created
under a page instance, or if an existing page type can move under a page
instance.
2015-12-03 12:56:52 +00:00
Matt Westcott
b1c75644f6
Stop replace_text from replacing multiple times on MTI subclasses.
...
Iterating over get_page_models means that these will be visited once
per superclass. To avoid this, we filter the page list to those exactly
matching the page class. This is done via a new `exact_type` method
on `PageQuerySet`.
2015-12-01 12:35:31 +00:00
Matt Westcott
06897db7c5
Add a get_page_models function to wagtailcore.models; deprecate direct use of PAGE_MODEL_CLASSES
2015-12-01 10:22:47 +00:00
Matt Westcott
c35ae95d9b
Document the remaining PageQuerySet methods
2015-11-30 22:16:08 +00:00
Rich Brennan
ce57281f6a
Move content_panels inside FormPage definition.
2015-11-24 10:36:30 +00:00
Matt Westcott
c025e1d3e5
Add a can_choose_root flag to PageChooserPanel.
...
This restores the previous behaviour, since there are plausible scenarios where choosing the root might be appropriate.
2015-11-02 15:12:42 +00:00
Matt Westcott
42af5c10af
Merge branch 'merge-settings' of https://github.com/takeflight/wagtail into takeflight-merge-settings
2015-10-23 10:31:27 +01:00
Matt Westcott
33e4a7497f
Release note / documentation update for #1790
2015-10-22 17:23:17 +01:00
Tim Heap
c9f73d3157
Fix typo in settings docs
2015-10-21 16:39:09 +11:00
Tim Heap
3d494fb24b
Move wagtailsettings into contrib module
...
The `wagtailsettings` module is useful enough that it should be included
in the Wagtail contrib section, to make it available to all Wagtail
developers.
All the code has been given a once-over to make sure it is nice and
polished before being copied in. As such, this is not a direct copy of
the `wagtailsettings` module. It should be backwards compatible though,
excepting the new location.
It has been moved to `wagtail.contrib.settings`, following the naming
scheme set out in #1504 .
Documentation has been concatenated in to a single page, and added to
the contrib reference section.
2015-10-21 16:39:09 +11:00
Matt Westcott
141129f587
Merge branch 'docs/signals' of https://github.com/JoshBarr/wagtail into JoshBarr-docs/signals
2015-10-16 17:23:04 +01:00
Matt Westcott
bebc4d4ed3
Remove mention of SASS / django-compressor; fix minor text errors
2015-10-15 09:21:47 +01:00
Matt Westcott
e1b564ee80
Merge branch 'cleanup/project-template-documentation' of https://github.com/timorieber/wagtail into timorieber-cleanup/project-template-documentation
2015-10-15 09:18:42 +01:00
Timo Rieber
f522b146b3
Removed vagrant configuration section
2015-10-15 08:11:16 +02:00
Timo Rieber
8e2c5cfd87
Synced structure to reflect current project template
2015-10-15 08:10:27 +02:00
Karl Hobley
6eae465e64
Renamed "self" template variable to "page" in docs
2015-10-13 09:52:16 +01:00
Matt Westcott
c21800b7b0
Merge branch 'inline-panel-min-max' of https://github.com/kaedroho/wagtail into kaedroho-inline-panel-min-max
...
Conflicts:
wagtail/wagtailadmin/edit_handlers.py
2015-10-09 15:42:54 +01:00
Matt Westcott
7d67e4b448
Minor copyediting on the Pages 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
e1bb391625
editing_api => panels
2015-10-05 21:07:08 +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
Josh Barr
a324ea5b54
slim chances of career change to English teaching
2015-10-06 01:29:56 +13:00
Josh Barr
8036cff94b
added some basic signals docs
2015-10-06 01:18:25 +13:00
Josh Barr
221a3e5254
added docs about hostnames
2015-09-27 01:41:52 +12:00
Tim Heap
5df60caef3
Rename is_abstract
to is_creatable
...
`is_creatable` better reflects what it is used for, and stops any
confusion between Wagtail's `is_abstract` and Django's `Meta.abstract`.
`is_creatable` takes in to account `Meta.abstract` now, so developers
will no longer need to set both `is_abstract` and `Meta.abstract`.
Documentation for the new attribute has been added, as well as tests.
2015-09-04 09:59:01 +10: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
7076e06ce7
Documentation for #1621
2015-08-25 16:15:31 +01:00
Tim Heap
537502b521
Add documentation for tagging snippets
2015-08-24 10:22:02 +10:00
Matt Westcott
85707d5925
Revert "Multiple page types in page chooser"
2015-08-11 18:00:05 +01:00
Tom Dyson
f8d2a9f456
Merge pull request #1565 from gasman/fix/remove-menu-classes
...
Remove all menu-{section_name} classnames on the <body> element and menu item <li>s
2015-08-11 12:39:03 +01:00
Karl Hobley
337a979257
#1582 - Fix typo in model reference
2015-08-05 14:13:00 +01:00
Nick Smith
b67426c86b
Merge branch 'master' into multiple-page-types-in-page-chooser
...
Conflicts:
wagtail/wagtailadmin/views/chooser.py
2015-08-03 18:11:38 +01:00
Nick Smith
38ee0991e6
Update #1533 according to feedback: docs and error message changes
2015-08-03 18:08:20 +01:00
Matt Westcott
a679d4f7f5
Remove all menu-{section_name} classnames on the <body> element and menu item <li>s.
...
These were introduced in 9d7d016b7c
to support menu item highlighting, but this mechanism was superseded by #1186 . There's no sign of any code still using these classnames, and any code that relies on them would be liable to fail on non-English-language sites anyhow (since the menu item name is derived from the label by default, and the label is a translatable string).
2015-07-30 23:19:12 +01:00
Karl Hobley
459a8c8b44
Renamed searchpicks app to searchpromotions
2015-07-21 13:37:42 +01:00
Karl Hobley
0710facc03
{% get_search_picks %} => {% get_search_promotions %}
2015-07-21 13:37:42 +01:00
Karl Hobley
669c7ac34c
Docs for searchpicks module
2015-07-21 13:37:42 +01:00
Karl Hobley
faabc18ce7
Docs for multiple page types in PageChooserPanel
2015-07-20 14:55:58 +01:00
Karl Hobley
d7953cc501
Added min_num and max_num parameters to InlinePanel
...
Fixes #669
2015-07-19 20:32:41 +01:00
Karl Hobley
f84af79c7d
Merge branch 'wagtailapi-descendant-of'
2015-07-15 10:01:47 +01:00
Karl Hobley
d3b9779141
Docs for descendant_of API filter
2015-07-15 09:57:53 +01:00
Karl Hobley
ad25aec535
Merge pull request #1480 from kaedroho/model-reference-tweaks
...
Model reference formatting tweaks
2015-07-14 09:38:50 +01:00
Karl Hobley
26dde89011
Tweaks to model reference
...
Now formatted in a similar way Django formats model references
2015-07-07 09:18:22 +01:00
Karl Hobley
25e5b97680
Tweaks to headers
2015-07-06 19:22:48 +01:00
Karl Hobley
70e83e8821
modelcluster.tags => modelcluster.contrib.taggit
2015-07-06 09:29:18 +01:00
Tim Heap
7d7eece0d1
Add .specific()
page queryset method
2015-06-29 15:53:18 +01:00
Karl Hobley
369d2d437a
Merge pull request #1422 from kaedroho/routablepage-docs-improvements
...
Improvements to RoutablePage docs
2015-06-24 09:52:29 +01:00
Karl Hobley
0ed4e26d63
Merge pull request #1423 from kaedroho/staticsitegen-example-fix
...
Update staticsitegen example to use new RoutablePage syntax
2015-06-19 11:40:49 +01:00
Karl Hobley
e2a331febe
Made listing view example a little bigger
2015-06-19 10:34:14 +01:00
Karl Hobley
94b18ad658
Fix reference to forms doc
2015-06-19 10:19:03 +01:00
Karl Hobley
ad2dfd81a2
Update staticsitegen example to use new RoutablePage syntax
2015-06-19 10:08:37 +01:00
Karl Hobley
e0a1802f7c
Improvements to RoutablePage docs
2015-06-19 09:55:30 +01:00
Karl Hobley
9713250c42
Moved theory doc into reference
2015-06-05 13:54:15 +01:00
Karl Hobley
7167b9bdab
Merge pull request #1353 from kaedroho/docs-tweaks
...
A little more restructuring of the docs
2015-06-05 13:29:54 +01:00
Karl Hobley
0cecb61862
Moved form builder to contrib
...
It will soon be contrib
2015-06-02 09:14:56 +01:00
Karl Hobley
201164ccb5
Moved page privacy to advanced topics
2015-06-02 09:14:55 +01:00
Karl Hobley
98692f9bfa
Moved snippets to topics
2015-06-02 09:14:20 +01:00
Karl Hobley
8c75baa271
Removed sendfile dependency
...
Not actually needed unless you're setting a SENDFILE_BACKEND and in that case, you'll know you need it.
2015-06-01 16:49:12 +01:00
Karl Hobley
3b26ddc162
Fixed module names for a few classes
2015-06-01 16:03:59 +01:00
Karl Hobley
f9f6d52670
Moved page editor customisation to customisation section
2015-05-30 23:17:39 +01:00
Karl Hobley
9885d2fb7d
Fix typos
2015-05-29 14:21:08 +01:00
Karl Hobley
77d143a099
Some edits to model reference
2015-05-29 12:53:48 +01:00
Karl Hobley
a0ddfc9fec
Tweak to the RoutablePageMixin examples
...
Use view names as defined in the example above
2015-05-28 15:18:18 +01:00
Karl Hobley
2e0dcc88d5
Moved some of the reference docs into topics
2015-05-28 12:57:00 +01:00
Dave Cranwell
bd45a12efd
Simplified getting started section
2015-05-28 10:13:05 +01:00
Karl Hobley
f2012bcde0
Merge pull request #1319 from kaedroho/more-pages-docs-tweaks
...
Various improvements to pages docs
2015-05-27 09:47:34 +01:00
Karl Hobley
a177a69824
Merge pull request #1306 from kaedroho/custom-image-model-docs
...
Add docs for custom image models
2015-05-27 09:40:52 +01:00
Karl Hobley
30eed43d10
Merge pull request #1318 from kaedroho/frontend-search-docs
...
Update frontend search view docs
2015-05-27 09:40:39 +01:00
Harris L.
de7f1b4456
Update creating_pages.rst
...
Restore a missing `+`.
2015-05-20 12:25:09 -04:00
Karl Hobley
9139e6454f
Removed the little sites doc
...
Sites now have some reference documentation in the page models reference
2015-05-18 16:34:42 +01:00
Karl Hobley
ec0c9917c6
Improvements to the page model reference docs
2015-05-18 16:30:55 +01:00
Karl Hobley
6d6863c01d
Link to routablepage from "adding endpoints to pages" docs
2015-05-18 15:17:27 +01:00
Karl Hobley
29cd935dc3
Rename queryset reference and privacy pages
2015-05-18 15:12:19 +01:00
Karl Hobley
d2d43dca0a
Better formatting for page fields reference
...
No on the class so they can now be referenced with :meth:
2015-05-18 15:09:12 +01:00
Karl Hobley
01c38e27cd
Improvements to cross-linking
2015-05-18 15:09:12 +01:00
Karl Hobley
605fdc62f7
Moved page field reference to page model reference
2015-05-18 15:09:12 +01:00
Karl Hobley
eee3d42735
Update frontend search view docs
...
We no longer recommend using Wagtails built in search view.
This commit adds an example view that anyone can use in their project instead.
2015-05-18 13:48:41 +01:00
Karl Hobley
2940ea9c9b
Fix too short underline
2015-05-18 13:24:48 +01:00
Karl Hobley
9dd4b0391a
Improvements to Page model reference docs
...
- Rename to "Page model reference"
- Add docs for fields
- Add docs for other models such as revisions, group page permissions, etc
2015-05-18 12:14:01 +01:00
Karl Hobley
980a29d839
Tweaks to editing api docs
...
Based on feedback from @tomdyson on #1310
2015-05-18 10:49:12 +01:00
Karl Hobley
b078bb755a
Spellchecked editing api docs
2015-05-18 10:44:07 +01:00
Karl Hobley
e04fa2b471
Merge rich text docs
2015-05-18 10:43:36 +01:00
Karl Hobley
866b762b7b
Merge "collapsing multi field panels" into MultiFieldPanel
2015-05-18 10:43:36 +01:00
Karl Hobley
3f780a1d8c
2 => 4 spaces
2015-05-18 10:43:36 +01:00
Karl Hobley
b92b1f7edb
Remove duplicate docs for col classes
2015-05-18 10:43:36 +01:00
Karl Hobley
a2804d2fe6
Move chooser panels next to other panels
2015-05-18 10:43:36 +01:00
Karl Hobley
e3fc465360
Move panels explanation above listing of panels types
2015-05-18 10:43:36 +01:00
Karl Hobley
457f5908a8
Break down FieldRowPanel docs
...
Hopefully, more reabable
2015-05-18 10:43:36 +01:00
Karl Hobley
ad222ffb18
Restructured basic panels docs
2015-05-18 10:43:36 +01:00
Karl Hobley
175d147e09
Tweaks to coding style of model examples
2015-05-18 10:43:36 +01:00
Karl Hobley
22ba2328a1
Don't document Documents here
...
Not the right place for it
2015-05-18 10:43:36 +01:00
Karl Hobley
fb51fc3db8
Document using feature detection with custom image model
2015-05-18 10:19:32 +01:00
Karl Hobley
78a11e98f8
Add docs for custom image models
2015-05-18 10:19:32 +01:00
Karl Hobley
8b3bc775d7
Change titles to links on contrib index
2015-05-14 16:01:03 +01:00
Karl Hobley
9420930f18
Rename docs for contrib modules
2015-05-14 15:27:14 +01:00
Karl Hobley
543cedec40
Merge remote-tracking branch 'davecranwell/docs-reorganisation'
2015-05-14 12:14:58 +01:00
Dave Cranwell
5c16f9e7e0
moved attr/prop/method reference into pages section
2015-05-14 11:54:41 +01:00
Dave Cranwell
3e5eb60bf9
moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README
2015-05-14 11:20:50 +01:00
Karl Hobley
e145e8ebcf
Spelling corrections
2015-04-19 10:53:34 +01:00
Karl Hobley
739ef64cf1
Started fixing spellings. Added wordlist
2015-04-17 23:05:08 +01:00
Karl Hobley
8d162d0a86
Removed all versionadded older than 0.7
2015-04-09 17:03:33 +01:00
Dan Braghis
aa5fe7574b
Tweak code and docs based on feedback
2015-04-03 18:34:03 +01:00
Dan Braghis
c174de8724
Rename construct_wagtail_edit_bird hook
2015-04-03 13:36:32 +01:00
Matt Westcott
a83a16de5c
release note for #1114
2015-03-30 12:41:01 +01:00
Matt Westcott
24c04ee709
documentation for the construct_homepage_summary_items hook
2015-03-30 11:37:06 +01:00
Karl Hobley
8ea5054a1b
Moved hooks into their own file
2015-03-26 14:17:35 +00:00
Matt Brailsford
08a5ac9b36
Update page.rst
...
Added parent_page_types docs and updated subpage_types docs to include instructions on blocking child page creation altogether.
2015-02-21 10:05:41 +00:00
Karl Hobley
096d1fd42c
Moved page fields reference into reference section
2015-02-19 16:53:24 +00:00
Karl Hobley
3cdedf12f2
Docs updates
2015-02-16 10:27:17 +00:00
Matt Westcott
ad80554558
fix warning about code-block directive
2014-10-08 10:57:10 +01:00
Karl Hobley
1bce98795e
Docs for update_index --backend option
2014-09-18 10:37:09 +01:00
Karl Hobley
2b9249907b
Added reference section
2014-07-25 15:33:41 +01:00