Commit graph

72 commits

Author SHA1 Message Date
Deniz Turgut
8a56e1f1fa Update namespace docs to address review 2019-12-01 20:29:42 +03:00
Deniz Turgut
87a5c82197 Documentation update for namespace plugins 2019-12-01 19:29:41 +03:00
Justin Mayer
e35120faa8
Merge branch 'master' into line-limit 2018-11-03 16:18:25 +01:00
MinchinWeb
3a0add4b6e Convert FEED settings from %s to {slug} redux (#2432)
* Convert FEED settings from `%s` to `{slug}` redux

Closes #2106, Closes #2383
2018-11-03 16:12:20 +01:00
MinchinWeb
f595741b8e Docs: Reflow to 79 char line limit 2018-11-02 20:53:15 -06:00
Benjamin ABEL
30a472a8a3
[DOC] register function missing 2018-02-12 15:14:27 +01:00
Sergei K
17b37358e9 Add a new signal: page_generator_write_page 2017-10-17 07:38:18 +05:00
Bernhard Scheirle
927d9c7ea5 Add new signal: feed_generated
This signal gets emitted before a feed gets written to disk.
Therefore it allows plugins to do arbitrary changes to the feed.
2017-01-16 11:33:13 +01:00
derwinlu
e3f5e39e17 fix outdated content_object_init refs
* remove content_object_init section from docs
* improve content_object_init test

The content_object_init signal used to set its class as sender and pass
the instance as additional arg in 6100773. Commit ed907b4 removed this
behaviour to bring it inline with other signals, on the basis that
you can test for the class of the object anyway.
We also had a test in place, checking this behaviour, but it was poorly
implemented, not actually checking if the function ever got called.

closes #1711
2015-06-12 19:23:17 +02:00
Justin Mayer
807b3bced3 Merge pull request #1471 from roidelapluie/master
Add a new signal: page_writer_finalized
2015-05-06 13:13:48 +02:00
Kernc
265f68a879 Add signal: all_generators_finalized (getpelican/pelican-plugins#314)
Some plugins have used `content_object_init` signal and read `summary`
or `content` properties of the content object. This resulted in
internal (`{filename}`) links being unresolved. When used, this signal
should hopefully mitigate that.

See also:
* https://github.com/getpelican/pelican-plugins/issues/314
* https://github.com/getpelican/pelican-plugins/pull/410
2015-02-07 16:13:12 +01:00
Ondrej Grover
f87e4faa22 add notices about caching interfering with changes to settings and plugins 2014-11-03 21:54:08 +01:00
Tom Most
e65d33b89c Warn that signal receivers are weakly-referenced
For the signal get_generators in particular, it may seem natural to use
a lambda or inner function as the signal receiver, but this does not
work as the receiver is collected before it can be called.
2014-11-02 14:39:08 -08:00
Forest
96eaf9cea0 Spelling correction in docs: usefull -> useful. 2014-10-01 02:05:49 -07:00
Julien Pivotto
c92e00f17b Add a new signal: page_writer_finalized 2014-09-19 10:12:42 +02:00
Artemy Tregubenko
0093984861 Add feed_written signal 2014-08-28 20:09:42 +02:00
Ondrej Grover
21882fd4a0 Fix #1344 move PLUGIN_PATH -> PLUGIN_PATHS
Pelican uses *_PATHS names for settings that represent a list of paths.
2014-05-14 14:19:52 +02:00
Ondrej Grover
5a3daae72f add get_writer signal and unify with get_generators
Fix outdated docs of get_generators to unify.
2014-04-27 14:25:08 +02:00
Justin Mayer
ddc5367231 Merge pull request #1328 from Scheirle/StaticGeneratorSignals
Send the static_generator_{init, finalized} signals
2014-04-26 10:25:13 -07:00
Bernhard Scheirle
30e2cac753 send the static_generator_{init, finalized} signals.
Note: The two signals were already present but were never sent.
2014-04-24 15:30:34 +02:00
Justin Mayer
f0802e8114 Text tweaks for "PLUGIN_PATH as list" feature 2014-04-18 13:21:06 -07:00
Lonewolf
c386e29d0c Ability to specify PLUGIN_PATH as list
PLUGIN_PATH added to settings table
2014-04-18 12:59:06 -07:00
Ondrej Grover
22762f2c16 add signal article_generator_pretaxonomy
invoked before categories and tags lists are created
useful when e.g. modifying the list of articles to be generated
so that removed articles are not leaked in categories or tags
2014-02-07 08:34:27 +01:00
Alistair Magee
45bc018672 add the new signal to the docs 2014-01-25 20:44:15 +00:00
Stefan hr Berder
f750f38d60 add a signal on article writing 2014-01-03 05:03:25 +01:00
Jed Brown
2b5db0321b docs/plugins.rst: fix signal name "page_generator_context"
The old "pages_generate_context" dates from before pelican-3.2
standardization, but AFAIK, "page_generate_context" was never correct.
2013-10-11 22:30:27 -05:00
Justin Mayer
f6c9237a01 Enhance and correct documentation 2013-09-23 19:30:51 +02:00
Alexis Métaireau
339955376e Add a content_written signal 2013-08-17 12:48:34 +02:00
Talha Mansoor
b0a13a851c Fix a typo in the docs
getpelican/pelican@f2d6f77462 changed
`article_generate_context` to `article_generator_context`. This commit
updates the docs to reflect the change.
2013-08-11 02:20:25 +05:00
Simon Conseil
f47f054d0b Add documentation for readers. 2013-08-07 00:43:49 +02:00
Alexis Métaireau
4fa9184b01 Start a section about plugin recipes in the docs 2013-08-01 14:47:56 +02:00
W. Trevor King
8797f0ebef docs/plugins.rst: Document signal name changes 2013-06-12 17:37:21 -04:00
W. Trevor King
7be16dd524 generators: Update PagesGenerator to use new read_file
Also standardize signal names.  If `article_generator_*` is singular,
`page_generator_*` should be as well.  Fix it from the older
`pages_generator_*`.
2013-06-12 15:02:31 -04:00
Justin Mayer
70a72545ce Add content_object_init to list of signals 2013-04-20 09:08:46 -07:00
Justin Mayer
8be7c0dbae Minor documentation improvements 2013-04-16 10:13:47 -07:00
Deniz Turgut
c4b3ad58e8 remove plugins, update docs and update dependecies 2013-04-12 23:39:39 -04:00
Deniz Turgut
c2924402ad Fix for issue #428: Use PLUGIN_PATH properly 2013-04-05 02:39:12 -04:00
Deniz Turgut
8710982d2a fixed related_posts plugin 2013-03-26 23:17:59 -04:00
Eric
6f5d8eae96 Relative URL issues with the related post examples
I noted that if you set the `ARTICLE_URL` site variable to have some depth and just create relative links, they will not link correctly.

by prefacing the link with `{{ SITEURL}}/` it seems to ensure proper links are created and works with the `make devserver` mode
2013-03-03 22:18:59 -08:00
dave mankoff
3f4406dd6b support inline summary specification
update documentation

change summary cutoff to a plugin

remove backup file

fix 3.2 tests

update summary plugin initialization and documentation

update documentation

fix documentation formatting
2013-02-12 22:35:02 -05:00
Chris Streeter
de44644700 Add a pages_generator_finalized signal.
I wrote a plugin that I'd like to also be able to run on pages in
addition to articles. Adding this signal will let me update the content
when a page is finished being generated.
2013-02-10 12:42:54 -08:00
Alexis Metaireau
c8da208a91 Merge pull request #691 from webdesignhero/master
Related Post Plugin Example
2013-01-23 04:05:42 -08:00
Eric
0a6294a2a3 More clear example for related posts
The existing related posts example doesn't show properties for the collection, this could be confusing to individuals who are not programmers, because as it was the code would render five bullet points.

I am also looking to add some type of loop control or if statement to the loop to detect duplicate, I tried t a dictionary sort filter through jinja, bu that through an error, the following is not guarantted to work then:


		{% set LASTARTICLE = "notset" %}
		{% if article.related_posts %}
			<ul>
			{% for related_post in article.related_posts|dictsort(false, 'url')  %}
				{% if not (LASTARTICLE == related_post.url) %}
				   <li><a href="{{ related_post.url }}">{{ related_post.title }}</a></li>
				{% endif %}
				{% set LASTARTICLE = related_post.url %}
			{% endfor %}
			</ul>
		{% endif %}

the dicsort does not work (is this not a dict, I'm not a python guy so I'm just hacking at it.
2013-01-20 17:27:28 -06:00
Trae Blain
a71465217b Update webassets plugin to allow user to pass configuration settings to Webassets through their settings file. Also removed language about DEBUG not compiling CSS since as of at least webassets 0.8 this is no longer an issue. 2013-01-02 16:26:39 -06:00
Alexis Metaireau
d879218c27 Merge pull request #620 from rskvazh/patch-1
Update docs/plugins.rst
2012-12-18 01:15:50 -08:00
Trae Blain
b0ff693839 Updated plugins documentation to include actual callable names of each plugin included. 2012-12-07 14:40:44 -06:00
Roman Skvazh
694f318614 Update docs/plugins.rst
Change yuicompressor to yui_js and yui_css
2012-12-06 21:15:25 +04:00
Justin Mayer
a07b56c02b Doc fixes and improvements 2012-12-03 16:31:55 -08:00
Bruno Binet
3342d3b9b9 Added some documentation about the gzip plugin. 2012-11-29 15:00:44 +01:00
Bruno Binet
801bc755b5 Merge branch 'pr/558'
Conflicts:
	docs/settings.rst
	pelican/signals.py
2012-11-23 15:32:17 +01:00