Merge pull request #344 from plone/polyester-fixvarious

Polyester fixvarious

Author: sven

.gitignore

@@ -4,3 +4,4 @@ external
 broken*
 *.mo
 .DS_Store
+_locales

_templates/version_warning.html

@@ -2,8 +2,8 @@
 <div class="row">
   <div class="col-sm-12 admonition warning version_warning" >
     <p class="first admonition-title">Warning</p>
-    <p class="last">The version is a draft for Plone 5, this is WIP !!
-    !!DO NOT!! use this docs, please use the docs of the our current stable version
+    <p class="last">The version is a draft for Plone 5, this is a Work In Progress! Pull requests welcome... <br />
+    !!DO NOT!! use these docs in production, please use the docs of the our current stable version
     [Plone 4] <a href="http://docs.plone.org">Plone 4.3 Documentation</a></p>
   </div>
 </div>

about/contributing.rst

@@ -75,7 +75,7 @@ This is the recommended way for smaller changes, and for people who are not fami
 - Fill in the **Commit changes**-textbox at the end of the page telling why you did the changes. Press the **Commit changes**-button next to it when done.
 - Then head to the green *New pull request*-button (e.g. by navigating to your fork's root and clicking "Pull requests" on the right menu-bar, or directly via https://github.com/yourGitHubUserName/documentation/pulls), you won't need to fill in any additional text. Just press **New pull request** button, finally click "Send pull request".
 - Your changes are now queued for review under project's `Pull requests <https://github.com/plone/documentation/pulls>`_ tab on Github.
-- For more information about writing documentation please read the :doc:`styleguide </about/styleguide>` and also :doc:`this </about/helper_tools>`.
+- For more information about writing documentation please read the :doc:`styleguide </about/documentation_styleguide>` and also :doc:`this </about/helper_tools>`.
 - You will receive a message when your request has been integrated into the documentation. At that moment, feel free to delete the copy of the documentation you created under your account on github. Next time you contribute, just fork again. That way you'll always have a fresh copy of the documentation to work on.
 
 
@@ -106,7 +106,7 @@ advanced users.
 
 * Commit your changes and `create <https://help.github.com/articles/creating-a-pull-request>`_ and open `pull <https://help.github.com/articles/using-pull-requests>`_ request.
 
-For more information about writing documentation please read the :doc:`styleguide </about/styleguide>` and also :doc:`this </about/helper_tools>`.
+For more information about writing documentation please read the :doc:`styleguide </about/documentation_styleguide>` and also :doc:`this </about/helper_tools>`.
 
 Translation
 ===========

about/documentation_styleguide.rst

@@ -69,7 +69,7 @@ For including documentation into docs.plone.org, **please** follow these guideli
 
 * Please do not use 'autodoc' to include comments of your code.
 
-* Please follow this :doc:`ReST styleguide <styleguide>` and use **semantic linefeeds**.
+* Please follow this :doc:`ReST styleguide <rst-styleguide>` and use **semantic linefeeds**.
   Do **not** break your sentences into half with newlines because you somehow think you should follow PEP8.
   PEP8 is for Python files, not for ReStructuredText.
 

about/history/20150518.rst

@@ -1,6 +1,3 @@
-Changelog
-=========
-
 1.0.0-pre-alpha
 ----------------
 

about/history/next_release.rst

@@ -15,3 +15,11 @@ Changelog
 - **Provided one more example for the Title**
 
     *@fulv* provided more examples about titles in content items.
+
+- **Fix outdated links**
+
+    *@polyester* fixed many outdated and broken links
+
+- **rst syntax fixes**
+
+    *@polyester* fixed various rst syntax errors

about/index.rst

@@ -10,4 +10,12 @@ About this documentation
     documentation_styleguide
     rst-styleguide
     helper_tools
-    history/20150518
+    searching
+
+Changelog
+---------
+
+.. toctree::
+    :maxdepth: 2
+
+    history/20150518

about/searching.rst

@@ -13,7 +13,7 @@ Firefox
 
 `http://docs.plone.org <http://docs.plone.org>`_ is supporting `OpenSearch <http://www.opensearch.org/Home>`_.
 
-With this it is possible to search http://docs.plone.org <http://docs.plone.org>`_ with put the Firefox search bar.
+With this it is possible to search `http://docs.plone.org <http://docs.plone.org>`_ with put the Firefox search bar.
 
 Watch the `video <https://www.youtube.com/watch?v=J9gkjO_Xvxs>`_ .
 

adapt-and-extend/custom-ct/index.rst

@@ -1,16 +1,15 @@
 Custom Content-Types
 ====================
 
-The current recommended way to develop new custom content-types is by using :term:`Dexterity`. You'll find the full manual here.
+The recommended way to develop new custom content-types is by using :term:`Dexterity`. You'll find the full manual here.
 
 .. toctree::
    :maxdepth: 1
 
    /external/plone.app.dexterity/docs/index
 
-Up until Plone 4.1, the standard way was to use :term:`Archetypes`. You can still develop using Archetypes, if you prefer, and they will remain available.
+Up until Plone 4.1, the standard way was to use :term:`Archetypes`.
+You can still develop using Archetypes, and they will remain functional.
+For any **new** development, Dexterity is strongly recommended.
 
-.. toctree::
-   :maxdepth: 1
-
-   /old-reference-manuals/archetypes/index
+The Archetypes reference manual will remain available at the `Plone 4 documentention <http://docs.plone.org/4/en/old-reference-manuals/archetypes/index.html>`_

adapt-and-extend/theming/index.rst

@@ -14,12 +14,29 @@ Theming Plone
    :maxdepth: 2
 
    theme_product
+
+
+.. toctree::
+   :maxdepth: 2
+
+
    /external/plone.app.theming/docs/index
    /external/diazo/docs/index
-   quick_test
+
+.. toctree::
+   :maxdepth: 2
+
    resources
    barceloneta
 
+An older (Plone 4.2) quick guide which may help to understand Diazo better:
+
+.. toctree::
+   :maxdepth: 2
+
+   quick_test
+
+
 Using Diazo is also possible as a standalone service. That makes it possible to include several back-end applications under one 'look'
 
 .. toctree::
@@ -34,12 +51,7 @@ General information on the stylesheets and other resources in Plone
 
    templates_css/index
 
-Information on 'old-style' theming for Plone 3, but still valid in Plone 4.
-So upgrading from Plone3 to Plone4 is possible without switching to the new style of theming.
-
-Do note that for all **new** theme development, Diazo is strongly recommended.
-
-.. toctree::
-   :maxdepth: 2
+.. note ::
 
-   old_style_theming.rst
+    Up to version 4.1, Plone was using an older style of theming. Using that is not considered *best practice* anymore.
+    See `older versions of these docs <http://docs.plone.org/4/en/adapt-and-extend/theming/old_style_theming.html>`_ if you need the information.

adapt-and-extend/theming/old_style_theming.rst

@@ -35,7 +35,7 @@ The main unit of the resource system is a JavaScript file and/or a set of CSS/LE
 
 Since this can be a single JavaScript file, there are additional requirejs
 options are available to be able to customize. Possible options we have are
-is shim (export, init and depends) so it can be configured to be exported 
+is shim (export, init and depends) so it can be configured to be exported
 o the global namespace, init on load and depend on some other resource.
 
 An example of a resource definition on registry.xml::
@@ -69,8 +69,8 @@ The options are :
 The export/init/depends are the shim option to load the js files in the correct order on the global namespace, for more information : http://requirejs.org/docs/api.html#config-shim
 
 The URL option will you to define the base url in case you want to load txt resources on require js::
-        
-    registry.xml 
+
+    registry.xml
 
     <records prefix="plone.resources/mockup-patterns-structure"
             interface='Products.CMFPlone.interfaces.IResourceRegistry'>
@@ -106,12 +106,12 @@ The URL option will you to define the base url in case you want to load txt reso
 Default resources on Plone
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Plone loads a group of mockup components and bower components as resources on the registry. 
+Plone loads a group of mockup components and bower components as resources on the registry.
 In order to avoid running bower install on each installation of Plone it ships by default a minimal
 bower components folder on the CMFPlone static folder with the correct versions of the resources
 that are need to run the default plone js/css.
 
-The default bower components shipped are on : 
+The default bower components shipped are on :
 
 https://github.com/plone/Products.CMFPlone/blob/master/Products/CMFPlone/static/bower.json
 
@@ -142,7 +142,7 @@ Bundle
 
 Mainly bundles are groups of resources that are going to be loaded on your plone site. Instead of loading single resources we can group them by our possible needs. In case you
 develop an specific add-on you will need to create your own bundle, if you want to load a single page you will create a bundle, if you want to define some group of js/css that
-will be rendered on some page you need a bundle. 
+will be rendered on some page you need a bundle.
 
 Each bundle will be delivered on a production site as a standalone resource: two http calls (js/css) for each bundle
 
@@ -186,7 +186,7 @@ The options are :
 
 - jscompilation: URL where the minimized/compiled JavaScript version will be
 
-- csscompilation: URL where the minimized/compiled CSS version will be 
+- csscompilation: URL where the minimized/compiled CSS version will be
 
 - last_compilation: date of the compilation that is shipped on the compiled URL
 
@@ -275,7 +275,7 @@ Non compiled bundles
 ^^^^^^^^^^^^^^^^^^^^
 
 In case your resources are not using requirejs/less and you just want to group them on bundles to minimize and deliver them in groups you can use
-the non compiled bundles. 
+the non compiled bundles.
 
 They are minimized and stored on the csscompiled/jscompiled URL defined on the bundle for the first request each time:
 
@@ -333,10 +333,10 @@ In order to allow to have a complete theme its possible to define a bundle in di
     production-css = /++theme++barceloneta/less/barceloneta-compiled.css
     tinymce-content-css = /++theme++barceloneta/less/barceloneta-compiled.css
 
-    development-js = 
-    production-js = 
+    development-js =
+    production-js =
 
-This options allow us to define to plone that the js/css renderer will add the diazo one so we will be able to overwrite the 
+This options allow us to define to plone that the js/css renderer will add the diazo one so we will be able to overwrite the
 <link> <script> tags from the theme with the plone ones loading the diazo resources.
 
 As on the native plone bundles its possible to define a development/production set (less/requirejs) so it integrates with the
@@ -364,7 +364,7 @@ TODO
 Browser Page bundle
 ^^^^^^^^^^^^^^^^^^^
 
-If you want that your browser page loads or unloads an specific bundle when its rendered you can use::
+If you want that your browser page loads or unloads an specific bundle when its rendered you can use:
 
 TODO
 
@@ -444,7 +444,7 @@ Example::
 requirejs require/define and resource/bundle
 --------------------------------------------
 
-In working with requirejs, you'll likely be aware of the 
+In working with requirejs, you'll likely be aware of the
 `mismatched anonymous define() <http://requirejs.org/docs/errors.html#mismatch>`_
 potential misuse of require and define.
 

adapt-and-extend/theming/resources.rst

@@ -2,11 +2,9 @@
  Glossary
 ==========
 
-This is a glossary for some definitions used in this documentation and
-still heavily under construction.
+This is a glossary for some definitions used in this documentation and still heavily under construction.
 
-It incorporates the original `glossary on plone.org
-<https://plone.org/documentation/glossary>`_.
+It incorporates the original `glossary on plone.org <https://plone.org/documentation/glossary>`_.
 
 .. glossary:: :sorted:
 
@@ -484,7 +482,7 @@ It incorporates the original `glossary on plone.org
         and loaded. This is not the case in Zope 3. If you don't enable it
         explicitly, it will not be found.
 
-        
+
 
     .po
         The file format used by the :term:`gettext` translation system.
@@ -549,3 +547,5 @@ It incorporates the original `glossary on plone.org
     Buildout
         Buildout is a Python-based build system for creating, assembling and deploying applications from multiple parts, some of which may be non-Python-based. It lets you create a buildout configuration and reproduce the same software later. See `buildout.org <http://www.buildout.org/en/latest/>`_
 
+    browserview
+         Plone uses a view pattern to output dynamically generated HTML pages. Views are the basic elements of modern Python web frameworks. A view runs code to setup Python variables for a rendering template. Output is not limited to HTML pages and snippets, but may contain JSON, file download payloads, or other data formats. See :doc:`views </develop/plone/views/browserviews>`

appendices/glossary.rst

@@ -1,17 +1,20 @@
 older manuals
 =============
 
-Some of these are still valid, and give a deeper understanding of the Plone/Zope ecosystem
+Some of these are still valid, and can give a deeper understanding of the Plone/Zope ecosystem.
 
-.. toctree::
-   :maxdepth: 1
+.. note::
+
+  These manuals are not updated anymore
+
+
+- `Buildout <http://docs.plone.org/4/en/old-reference-manuals/archgenxml/index.html>`_
+- `using zope.formlib <http://docs.plone.org/4/en/old-reference-manuals/formlib/index.html>`_
+- `using zope.formlib <http://docs.plone.org/4/en/old-reference-manuals/formlib/index.html>`_
+- `zope.formlib <http://docs.plone.org/4/en/old-reference-manuals/forms/index.html>`_
+- `Zope 2 vs. Zope 3 practices <http://docs.plone.org/4/en/old-reference-manuals/old-style-vs-new-style/index.html>`_
+- `Pluggable Authentication Service <http://docs.plone.org/4/en/old-reference-manuals/pluggable_authentication_service/index.html>`_
+- `Portlets <http://docs.plone.org/4/en/old-reference-manuals/portlets/index.html>`_
+- `PloneTestCase tests <http://docs.plone.org/4/en/old-reference-manuals/testing/index.html>`_
+- `Zope 2 internals <http://docs.plone.org/4/en/old-reference-manuals/zope_secrets/index.html>`_
 
-   /old-reference-manuals/archgenxml/index
-   /old-reference-manuals/buildout/index
-   /old-reference-manuals/formlib/index
-   /old-reference-manuals/forms/index
-   /old-reference-manuals/old-style-vs-new-style/index
-   /old-reference-manuals/pluggable_authentication_service/index
-   /old-reference-manuals/portlets/index
-   /old-reference-manuals/testing/index
-   /old-reference-manuals/zope_secrets/index