{ "info": { "author": "William Minchin", "author_email": "w_minchin@hotmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Pelican :: Plugins", "Intended Audience :: Developers", "License :: OSI Approved :: GNU Affero General Public License v3", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "=======\nSummary\n=======\n\n``Summary`` is a plugin for `Pelican `_,\na static site generator written in Python.\n\n``Summary`` allows easy, variable length summaries directly embedded into\nthe body of your articles.\n\n\nInstallation\n============\n\nThe easiest way to install ``Summary`` is through the use of pip. This\nwill also install the required dependencies automatically.\n\n.. code-block:: sh\n\n pip install minchin.pelican.plugins.summary\n\nThen, in your ``pelicanconf.py`` file, add ``Summary`` to your list of\nplugins:\n\n.. code-block:: python\n\n PLUGINS = [\n # ...\n 'minchin.pelican.plugins.summary',\n # ...\n ]\n\nYou may also need to configure the summary start and end markers (see\nConfiguration below).\n\n\nRequirements\n============\n\n``Summary`` depends on (and is really only useful with) Pelican. This can\nbe manually installed with pip:\n\n.. code-block:: sh\n\n pip install pelican\n\n\n\nConfiguration and Usage\n=======================\n\nThis plugin introduces two new settings: ``SUMMARY_BEGIN_MARKER`` and\n``SUMMARY_END_MARKER``: strings which can be placed directly into an\narticle to mark the beginning and end of a summary. When found, the\nstandard ``SUMMARY_MAX_LENGTH`` setting will be ignored. The markers\nthemselves will also be removed from your articles before they are\npublished. The default values are ```` and\n````.\n\nFor example::\n\n Title: My super title\n Date: 2010-12-03 10:20\n Tags: thats, awesome\n Category: yeah\n Slug: my-super-post\n Author: Alexis Metaireau\n\n This is the content of my super blog post.\n \n and this content occurs after the summary.\n\nHere, the summary is taken to be the first line of the post. Because no\nbeginning marker was found, it starts at the top of the body. It is\npossible to leave out the end marker instead, in which case the summary\nwill start at the beginning marker and continue to the end of the body.\n\nIf no beginning or end marker is found, and if\n``SUMMARY_USE_FIRST_PARAGRAPH`` is enabled in the settings, the summary\nwill be the first paragraph of the post.\n\nThe plugin also sets a ``has_summary`` attribute on every article. It is\nTrue for articles with an explicitly-defined summary, and False otherwise.\n(It is also False for an article truncated by ``SUMMARY_MAX_LENGTH``.)\nYour templates can use this e.g. to add a link to the full text at the end\nof the summary.\n\nreST example\n~~~~~~~~~~~~\n\nInserting the markers into a reStructuredText document makes use of the\ncomment directive, because raw HTML is automatically escaped. The reST\nequivalent of the above Markdown example looks like this::\n\n My super title\n ##############\n\n :date: 2010-12-03 10:20\n :tags: thats, awesome\n :category: yeah\n :slug: my-super-post\n :author: Alexis Metaireau\n\n This is the content of my super blog post.\n\n .. PELICAN_END_SUMMARY\n\n and this content occurs after the summary.\n\nCredits\n=======\n\nOriginal plugin from the `Pelican-Plugins repo\n`_.\n\nLicense\n=======\n\nThe plugin code is assumed to be under the AGPLv3 license (this is the\nlicense of the Pelican-Plugins repo).", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/MinchinWeb/minchin.pelican.plugins.summary", "keywords": "", "license": "GNU Affero General Public License v3", "maintainer": "", "maintainer_email": "", "name": "minchin.pelican.plugins.summary", "package_url": "https://pypi.org/project/minchin.pelican.plugins.summary/", "platform": "any", "project_url": "https://pypi.org/project/minchin.pelican.plugins.summary/", "project_urls": { "Homepage": "https://github.com/MinchinWeb/minchin.pelican.plugins.summary" }, "release_url": "https://pypi.org/project/minchin.pelican.plugins.summary/1.1.1/", "requires_dist": null, "requires_python": "", "summary": "This Pelcan plugin allows easy, variable length summaries directly embedded into the body of your articles.", "version": "1.1.1" }, "last_serial": 2811427, "releases": { "1.1.0": [ { "comment_text": "", "digests": { "md5": "14e3f0134791860efa2208dcce0e4a64", "sha256": "e9a997482e848f270bd00816a9ad07ed09d97274f565d77fff203d8850a6ae61" }, "downloads": -1, "filename": "minchin.pelican.plugins.summary-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "14e3f0134791860efa2208dcce0e4a64", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9340, "upload_time": "2017-01-30T05:59:07", "url": "https://files.pythonhosted.org/packages/77/0a/317ac0a9f3fe215af64dcd358cb45b5048d8241d184d5002f83967b71894/minchin.pelican.plugins.summary-1.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0ea64c7cab78e5f8a53e44c4dbdc91a8", "sha256": "6be25b80d4af70be93c0547e05eff0e0b22f1e47248ffa9b2d1083604e4c3748" }, "downloads": -1, "filename": "minchin.pelican.plugins.summary-1.1.0.tar.gz", "has_sig": false, "md5_digest": "0ea64c7cab78e5f8a53e44c4dbdc91a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18577, "upload_time": "2017-01-30T05:45:40", "url": "https://files.pythonhosted.org/packages/dc/22/6550ac57c0a2e514f0f41c00e5d017b3911082bc5537cf628e01b4a92d8e/minchin.pelican.plugins.summary-1.1.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "1f6c8d3859b4ecb8965f3c616bd2fe88", "sha256": "0694be108105024a3465e69fdbdd3151bf54987c942903fea7ca754ba5302ca2" }, "downloads": -1, "filename": "minchin.pelican.plugins.summary-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "1f6c8d3859b4ecb8965f3c616bd2fe88", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9319, "upload_time": "2017-04-18T15:17:41", "url": "https://files.pythonhosted.org/packages/24/37/864b0e99ceab6db7d6490b3af6c2a85a0d5f222229c94c8124001404eb2f/minchin.pelican.plugins.summary-1.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "30af7395d65eff64eb5cf68d3259cdbe", "sha256": "31053959ae28ccbd3559f1db4d1ff0e84f84431a7de0c5dbd19ec55b00daefa7" }, "downloads": -1, "filename": "minchin.pelican.plugins.summary-1.1.1.tar.gz", "has_sig": false, "md5_digest": "30af7395d65eff64eb5cf68d3259cdbe", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18640, "upload_time": "2017-04-18T15:16:40", "url": "https://files.pythonhosted.org/packages/81/d4/ce2cec3c64dd98083d51e2e7e3d0960a74facdb03d17e909beb3f2598c0a/minchin.pelican.plugins.summary-1.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1f6c8d3859b4ecb8965f3c616bd2fe88", "sha256": "0694be108105024a3465e69fdbdd3151bf54987c942903fea7ca754ba5302ca2" }, "downloads": -1, "filename": "minchin.pelican.plugins.summary-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "1f6c8d3859b4ecb8965f3c616bd2fe88", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9319, "upload_time": "2017-04-18T15:17:41", "url": "https://files.pythonhosted.org/packages/24/37/864b0e99ceab6db7d6490b3af6c2a85a0d5f222229c94c8124001404eb2f/minchin.pelican.plugins.summary-1.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "30af7395d65eff64eb5cf68d3259cdbe", "sha256": "31053959ae28ccbd3559f1db4d1ff0e84f84431a7de0c5dbd19ec55b00daefa7" }, "downloads": -1, "filename": "minchin.pelican.plugins.summary-1.1.1.tar.gz", "has_sig": false, "md5_digest": "30af7395d65eff64eb5cf68d3259cdbe", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18640, "upload_time": "2017-04-18T15:16:40", "url": "https://files.pythonhosted.org/packages/81/d4/ce2cec3c64dd98083d51e2e7e3d0960a74facdb03d17e909beb3f2598c0a/minchin.pelican.plugins.summary-1.1.1.tar.gz" } ] }