diff --git a/README.rst b/README.rst index 2078382..a82afa1 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,8 @@ :target: https://travis-ci.org/collective/collective.ifttt .. image:: https://coveralls.io/repos/github/collective/collective.ifttt/badge.svg :target: https://coveralls.io/github/collective/collective.ifttt - +.. image:: https://readthedocs.org/projects/collectiveifttt/badge/?version=latest + :target: https://collectiveifttt.readthedocs.io/en/latest/?badge=latest ================ collective.ifttt diff --git a/docs/Enable_RSS_feed_on_Plone.rst b/docs/Enable_RSS_feed_on_Plone.rst new file mode 100644 index 0000000..4d5dadd --- /dev/null +++ b/docs/Enable_RSS_feed_on_Plone.rst @@ -0,0 +1,117 @@ +Enable RSS Feed On Plone Site +============================== + +Introduction +------------- + +Plone can generate RSS feeds from folderish content types (folder / collection). +If you want to aggregate a particular set of content to an RSS feed, +you first create a collection content item and then enable RSS feed on this collection content item. +You can choose what content types with any required fields such as- `labels, dates, location or language` +ends up to the RSS stream. +Also, the collection is language aware so that it works correctly on multilingual sites. + +Below are a few example steps to enable RSS Feed on Plone Site, however you can tweak the configuration +to meet user requirement and make different kinds of RSS feed given the flexibility of collection. + +Enabling RSS Feed +----------------- + +*Step 1* + +Go to Site Setup + +.. image:: _static/images/Enable_Rss_Feed/Enable_RSS/Step1.png + +*Step 2* + +Select Syndication under General tab. + +.. image:: _static/images/Enable_Rss_Feed/Enable_RSS/Step2.png + +*Step 3* + +Select following and save: + + 1. `Allowed` + 2. `Search RSS enabled` + 3. `Show settings button` + 4. `Show feed link` + 5. Save + +.. image:: _static/images/Enable_Rss_Feed/Enable_RSS/Step3.png + +Creating the collection for RSS +------------------------------- + +*Step 1* + +Go to Site root + +.. image:: _static/images/Enable_Rss_Feed/creating_collection/Step1.png + +*Step 2* + +Add new collection + +.. image:: _static/images/Enable_Rss_Feed/creating_collection/Step2.png + +*Step 3* + +Configuration explained below will publish all available content, however it can be tweaked based on user requirements. + +1. Update ``Title`` to "Your site name - RSS feed" Or any other suitable name. + +2. For ``Select Criteria``, choose `Review State as Published` (Otherwise unpublished items will show in your feed +and people will get an error clicking on that URL) + +3. For ``Sort On`` choose `Effective date` in reversed order + +.. image:: _static/images/Enable_Rss_Feed/creating_collection/Step4.png + +*Step 4* + +On Settings tab + + 1. Choose ``Exclude from navigation`` (to make it disappear from navigation tree) + + 2. Change ``Short Name`` to "site-feed" or any other suitable name + + 3. Save + +.. image:: _static/images/Enable_Rss_Feed/creating_collection/Step5.png + + +*Step 5* + +Publish collection after the content seems to be right, using the workflow menu on the collection content item. + +.. image:: _static/images/Enable_Rss_Feed/creating_collection/Step6.png + +**Now your RSS feed is ready which can be tested by copy-pasting RSS URL from the site action \ +to your RSS Reader, like feeder.co or Mozilla Reader** + +Like in my case the URL to the RSS feed is- ``http://localhost:8080/Plone/site-feed/RSS`` \ +which is something like ``/path_to_parent_collection/collection_short-name/RSS`` + +.. image:: _static/images/Enable_Rss_Feed/creating_collection/Step8.png + +*Step 6* + +To show feed icons on Folders, you can enable it in syndication tab as shown below. +`However, many sites do not want to show those feed icons` + +.. image:: _static/images/Enable_Rss_Feed/creating_collection/syndication_tab.png + +.. image:: _static/images/Enable_Rss_Feed/creating_collection/Enable_feed_icon.png + +This is how feed icon on folders look like - + +.. image:: _static/images/Enable_Rss_Feed/creating_collection/feed_icon_on_folder.png + +To publish feed of a particular folder use RSS URL associated to that folder, which is something like - +``/path_to_parent_folder/folder_short-name/RSS`` + +Like for given folder(`Events`), it will be ``http://localhost:8080/Plone/events/RSS`` + + diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..bd8893c --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = collectiveifttt +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/_static/images/Enable_Rss_Feed/Enable_RSS/Step1.png b/docs/_static/images/Enable_Rss_Feed/Enable_RSS/Step1.png new file mode 100644 index 0000000..b386dbd Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/Enable_RSS/Step1.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/Enable_RSS/Step2.png b/docs/_static/images/Enable_Rss_Feed/Enable_RSS/Step2.png new file mode 100644 index 0000000..525dab6 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/Enable_RSS/Step2.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/Enable_RSS/Step3.png b/docs/_static/images/Enable_Rss_Feed/Enable_RSS/Step3.png new file mode 100644 index 0000000..882a714 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/Enable_RSS/Step3.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/Enable_feed_icon.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/Enable_feed_icon.png new file mode 100644 index 0000000..5cac1ba Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/Enable_feed_icon.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/Step1.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step1.png new file mode 100644 index 0000000..3dbacc8 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step1.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/Step2.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step2.png new file mode 100644 index 0000000..ccf5d05 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step2.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/Step3.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step3.png new file mode 100644 index 0000000..cf0d1b1 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step3.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/Step4.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step4.png new file mode 100644 index 0000000..f36834a Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step4.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/Step5.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step5.png new file mode 100644 index 0000000..74f9178 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step5.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/Step6.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step6.png new file mode 100644 index 0000000..6ff1e03 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step6.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/Step7.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step7.png new file mode 100644 index 0000000..b081661 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step7.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/Step8.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step8.png new file mode 100644 index 0000000..6ab6c99 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/Step8.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/feed_icon_on_folder.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/feed_icon_on_folder.png new file mode 100644 index 0000000..b8a0364 Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/feed_icon_on_folder.png differ diff --git a/docs/_static/images/Enable_Rss_Feed/creating_collection/syndication_tab.png b/docs/_static/images/Enable_Rss_Feed/creating_collection/syndication_tab.png new file mode 100644 index 0000000..6750b4d Binary files /dev/null and b/docs/_static/images/Enable_Rss_Feed/creating_collection/syndication_tab.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..acd5b48 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,155 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = u'collective.ifttt' +copyright = u'2018, Shriyanshagro' +author = u'Shriyanshagro' + +# The short X.Y version +version = u'' +# The full version, including alpha/beta/rc tags +release = u'' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'collectiveiftttdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'collectiveifttt.tex', u'collective.ifttt Documentation', + u'Shriyanshagro', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'collectiveifttt', u'collective.ifttt Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'collectiveifttt', u'collective.ifttt Documentation', + author, 'collectiveifttt', 'One line description of project.', + 'Miscellaneous'), +] \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index ab9e96c..ece021c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,24 @@ -================collective.ifttt -================ -User documentation +.. collective.ifttt documentation master file, created by + sphinx-quickstart on Mon May 21 15:35:31 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to collective.ifttt! +============================================ + +Welcome to collective.ifttt's documentation. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + Enable_RSS_feed_on_Plone + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..ee91a0f --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build +set SPHINXPROJ=collectiveifttt + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd