Fix: #670, Fix:typos, Fix: reST #789

svx · 2017-03-01T15:28:27Z

Fixes: #670

Improves: reST

Changes proposed in this pull request:

Change ZMI to Management Interface
Change Zope Management Interface to Management Interface
Fix various reST syntax errors
Fix typo

This is for 5.1 only, please do not cherry-pick into 4.x !
This is supposed to be released with 5.1, not before !

@tkimnguyen since you opened this issue, I added you as reviewer, thanks !

tkimnguyen · 2017-03-02T02:38:52Z

adapt-and-extend/config/content-settings.rst

@@ -80,6 +80,6 @@ All in all, this allows sophisticated setups, where some content items just foll

   **Defining your own workflows**

-   It is no problem to define your own workflows. By default, however, that involves a trip to the :doc:`ZMI Management Interface <management-interface>` which is not incredibly userfriendly, and defining new workflows is a task best left for your Site Administrator or other specialist.
+   It is no problem to define your own workflows. By default, however, that involves a trip to the :doc:`Management Interface <management-interface>` which is not incredibly userfriendly, and defining new workflows is a task best left for your Site Administrator or other specialist.


"user friendly" should be two words

tkimnguyen · 2017-03-02T02:39:49Z

adapt-and-extend/theming/theme_product.rst

-.. note:: ZMI > portal_view_customizations is an handy way to find the template path.
+.. note::
+
+   Management Interface > portal_view_customizations is an handy way to find the template path.


..."is a handy way"

tkimnguyen · 2017-03-02T02:40:22Z

appendices/glossary.rst

-        as appending ``/manage`` to your URL, for example:
+        The *Management Interface*.
+        A Management Interface that is accessible through the web.
+        Accessing is as simple as appending ``/manage`` to your URL, for example:


"Accessing it is as simple" (missing "it")

tkimnguyen · 2017-03-02T02:41:38Z

develop/addons/components/genericsetup.rst

@@ -29,7 +29,7 @@ GenericSetup XML files are usually in a ``profiles/default`` folder inside the a
 All run-time through-the-web (:term:`TTW`) configurable items, like viewlets order through ``/@@manage-viewlets`` page, are made repeatable using GenericSetup profile files.

 You do not need to hand-edit GenericSetup profile files.
-You can always change the configuration options through Plone or using the Zope Management Interface, and then you export the resulting profile as an XML file, using the *Export* tab in the ``portal_setup`` ZMI tool.
+You can always change the configuration options through Plone or using the Management Interface, and then you export the resulting profile as an XML file, using the *Export* tab in the ``portal_setup`` Management Interface.


"in portal_setup, accessible from the Management Interface"

tkimnguyen · 2017-03-02T02:42:08Z

develop/addons/components/genericsetup.rst

@@ -837,7 +837,7 @@ Note that you are always allowed to use the ``plone`` domain, but if the xml fil
      ...
    </object>

-  Note that when you go to the portal_actions tools in the ZMI, you will see an i18n domain specified for each action.
+  Note that when you go to the portal_actions tools in the Management Interface, you will see an i18n domain specified for each action.


"tool" should be singular

tkimnguyen · 2017-03-02T02:42:34Z

develop/addons/components/interfaces.rst

-different subsystems. They provide a more consistent and declarative
-way to define bridges between two different things, when duck-typing
+Plone extensively uses interfaces to define APIs between different subsystems.
+They provide a more consistent and declarative way to define bridges between two different things, when duck-typing


what is duck-typing?

tkimnguyen · 2017-03-02T02:43:19Z

develop/plone/content/archetypes/fields.rst

@@ -512,20 +512,17 @@ Example (mfabrik/rstpage/archetypes/fields.py)::
 Automatically generating description based on body text
 --------------------------------------------------------

-Below is a sample through-the-web Python Script which
-you can drop to any Plone through Zope Management Interface.
+Below is a through-the-web (ttw) Python Script which you can drop to any Plone through the Management Interface.


"TTW" (should be capitalized)

"you can drop into"

tkimnguyen · 2017-03-02T02:44:12Z

develop/plone/content/archetypes/fields.rst

 by taking the first three sentences.

-The script will provide logging output to standard Plone log
-(var/log and stdout if Plone is run in the debug mode).
+The script will provide logging output to standard Plone log (var/log and stdout if Plone is run in the debug mode).


"in debug mode"

tkimnguyen · 2017-03-02T02:45:02Z

develop/plone/content/dynamic_views.rst

@@ -309,10 +309,9 @@ Register the view against a marker interface:
         template="view.pt"
       />

-* Assign this marker interface to a content item using the Zope Management Interface
-  (:term:`ZMI`, via the Interfaces tab)
+* Assign this marker interface to a content item using the Management Interface, via the Interfaces tab


"Python" should be capitalized

tkimnguyen · 2017-03-02T02:45:44Z

develop/plone/content/dynamic_views.rst

-for all folders to another type. You can execute the script through
-the :term:`ZMI` as a Python Script.
+for all folders to another type.
+You can execute the script through the Management Interface as a Python Script.


"Script" should not be capitalized (unless you're referring to a "Script (Python)")

tkimnguyen · 2017-03-02T02:46:25Z

develop/plone/content/importexport.rst

@@ -37,7 +37,7 @@ To export objects from a site to another, do the following:

 * Zope .zexp to *youranothersite*/var/instance/import folder

-* Go to ZMI root of your another site
+* Go to the Management Interface root of your another site


"your another" should either be "your other" or just "another" (not sure of the context)

svx · 2017-03-02T07:25:30Z

Welcome in the world of 'old documentation' !

tkimnguyen · 2017-03-02T13:26:41Z

develop/plone/content/workflow.rst

@@ -23,7 +23,7 @@ For more information, see
 Creating workflows
 ------------------

-The recommended method is to use the portal_workflow user interface in the Zope Management Interface
+The recommended method is to use the portal_workflow user interface in the Management Interface


"use portal_workflow in the Management Interface"

tkimnguyen

Thanks for replacing "ZMI"! I found some minor tweaks to make.

tkimnguyen · 2017-03-02T13:27:19Z

develop/plone/content/workflow.rst

@@ -102,7 +102,7 @@ Disabling workflow for a content type
 If a content type doesn't have a workflow it uses its parent container security settings.
 By default, content types Image and File have no workflow.

-Workflows can be disabled by setting the workflow setting empty in portal_workflow in ZMI.
+Workflows can be disabled by setting the workflow setting empty in portal_workflow in the Management Interface.


"by leaving the workflow setting empty"

tkimnguyen · 2017-03-02T13:28:32Z

develop/plone/forms/ploneformgen.rst

@@ -9,11 +9,15 @@ PloneFormGen
 Introduction
 ------------

-*PloneFormGen* is a Plone add-on Product that provides a generic Plone form generator using fields, widgets and validators from Archetypes. Use it to build simple, one-of-a-kind, web forms that save or mail form input.
+*PloneFormGen* is a Plone add-on Product that provides a generic Plone form generator using fields, widgets and validators from Archetypes.


"is a Plone add-on that"

tkimnguyen · 2017-03-02T13:29:34Z

develop/plone/functionality/actions.rst



 Introduction
 ------------

-Plone has concept of actions which refer the end user functionality associated with site
-or content objects:
+Plone has concept of actions which refer the end user functionality associated with site or content objects:


instead of "refer", maybe "connect"?

tkimnguyen · 2017-03-02T13:30:06Z

develop/plone/functionality/collections.rst

@@ -62,7 +62,7 @@ features like localization and user-friendly titles.

 New criteria can be created through-the-web in Site setup -> Collection section.  Click "All fields" to see unenabled portal_catalog criteria.  Later the edited settings can be exported to GenericSetup XML profile using portal_setup tool (no need to create profile XMl files by hand).

-portal_catalog indices can be added through-the-web on ZMI portal_catalog tool tabs.
+portal_catalog indices can be added through-the-web on (ttw) through the Management Interface portal_catalog tool tabs.


remove "on" and capitalize "TTW"

tkimnguyen · 2017-03-02T13:31:49Z

develop/plone/misc/portal_transforms.rst


-Goto your site's portal_setup in ZMI, select your registered profile and import
+Goto your site's portal_setup in Management Interface, select your registered profile and import


tkimnguyen · 2017-03-02T13:33:33Z

develop/plone/searching_and_indexing/query.rst



 Accesing the ``portal_catalog`` tool
 ====================================

-Plone queries are performed using ``portal_catalog`` persistent tool which
-is available as an persistent object at the site root.
+Plone queries are performed using ``portal_catalog`` persistent tool which is available as an persistent object at the site root.


curious why we have to say it's persistent, and I think generally appending "tool" to portal_* is unnecessary

tkimnguyen · 2017-03-02T13:34:15Z

develop/plone/searching_and_indexing/query.rst

@@ -650,7 +651,7 @@ To get all catalog brains of certain content type on the whole site::

        campaign_brains = self.context.portal_catalog(portal_type="News Item")

-To see available type names, visit in portal_types tool in ZMI.
+To see available type names, visit in portal_types tool in Management Interface.


"in the Management Interface"

remove the first "in" and "tool", so "visit portal_types in the Management Interface"

tkimnguyen · 2017-03-02T13:35:03Z

develop/plone/searching_and_indexing/query.rst

@@ -1064,7 +1065,7 @@ site objects.
 Here is an example how to crawl through Plone content to search HTML
 snippets. This can be done by rendering every content object and check
 whether certain substrings exists the output HTML This snippet can be
-executed through-the-web in Zope Management Interface.
+executed through-the-web in Management Interface.


"the Management Interface"

tkimnguyen · 2017-03-02T13:35:15Z

develop/plone/security/local_roles.rst

@@ -15,7 +15,7 @@ for a folder and its children.

 By default Plone has roles like ``Contributor``, ``Reader``, ``Editor``, etc.
 and you can view these on the :guilabel:`Sharing` tab
-and in :term:`ZMI` :guilabel:`Security` tab.
+and in Management Interface :guilabel:`Security` tab.


"the Management Interface"

tkimnguyen · 2017-03-02T13:38:55Z

working-with-content/managing-content/ploneformgen/custom_validators.rst

@@ -75,7 +83,9 @@ modules
 Using a Python script
 =====================

-You'll be frustrated fast if you try to do anything smart in a single TALES expression. If you need to do something more complicated, add a Python Script to your form folder and call it via TALES. For example, if you added a script with the id includesSpam, you could call it with the expression::
+You'll be frustrated fast if you try to do anything smart in a single TALES expression.


"frustrated fast" should be "quickly frustrated"

tkimnguyen · 2017-03-02T13:42:15Z

@jensens @svx I was in the middle of reviewing and stopped to sleep :) I finished the review just now but you merged the PR 4 hours ago... not sure how to incorporate the tweaks I suggested.

Fix: #670, Fix:typos, Fix: reST

7666dc5

svx added 32 needs: review 33 needs: docs labels Mar 1, 2017

svx requested a review from tkimnguyen March 1, 2017 15:28

svx mentioned this pull request Mar 1, 2017

fix references to Zope Management Interface and ZMI #670

Closed

tkimnguyen reviewed Mar 2, 2017

View reviewed changes

Add: Fixes, suggested during review

5584dd8

jensens merged commit 8b9b397 into 5.1 Mar 2, 2017

jensens deleted the svx_fix#670_for_51 branch March 2, 2017 09:24

tkimnguyen reviewed Mar 2, 2017

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: #670, Fix:typos, Fix: reST #789

Fix: #670, Fix:typos, Fix: reST #789

svx commented Mar 1, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

svx commented Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen left a comment

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen Mar 2, 2017

tkimnguyen commented Mar 2, 2017


		Goto your site's portal_setup in ZMI, select your registered profile and import
		Goto your site's portal_setup in Management Interface, select your registered profile and import

Fix: #670, Fix:typos, Fix: reST #789

Fix: #670, Fix:typos, Fix: reST #789

Conversation

svx commented Mar 1, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

svx commented Mar 2, 2017

Choose a reason for hiding this comment

tkimnguyen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tkimnguyen commented Mar 2, 2017