Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readability #741

Merged
merged 13 commits into from Dec 12, 2019
Merged

Improve readability #741

merged 13 commits into from Dec 12, 2019

Conversation

jugmac00
Copy link
Member

@jugmac00 jugmac00 commented Dec 2, 2019

As I have to read through the Searching and Categorizing Content chapter of the Zope book anyway, I will improve formatting, fix minor issues like wording and typos, but I do not plan to update the article to be compatible with Zope 4/5 yet (also no new screen shots).

All in all I

  • improved formatting
  • cleaned up code examples a bit
  • fixed many typos
  • deleted references to arcane Zope versions
  • deleted references to both TextIndexNG3 and FieldedTextIndex

Thank you very much in advance, whoever will go through this longish pr.

I do not know the details what has changed between the early version of Zope described in the chapter and Zope 4/5, but I noticed several things:

  • some indexes are not described (e.g. BooleanIndex)
  • searchResults / getAllBrains are not described

Also fix minor wording issues.

modified:   docs/zopebook/SearchingZCatalog.rst
modified:   docs/zopebook/SearchingZCatalog.rst
Also fix typos, re-arrange text, delete references to very old Zope
versions.

modified:   docs/zopebook/SearchingZCatalog.rst
modified:   docs/zopebook/SearchingZCatalog.rst
... also delete paragraph about TextIndexNG, which does not get migrated
to Python 3.

modified:   docs/zopebook/SearchingZCatalog.rst
modified:   docs/zopebook/SearchingZCatalog.rst
... also fix typos.

modified:   docs/zopebook/SearchingZCatalog.rst
... also fix typos.

modified:   docs/zopebook/SearchingZCatalog.rst
modified:   docs/zopebook/SearchingZCatalog.rst
.. as both are obsolete.

modified:   docs/zopebook/SearchingZCatalog.rst
modified:   docs/zopebook/SearchingZCatalog.rst
@jugmac00 jugmac00 marked this pull request as ready for review December 3, 2019 12:31
Copy link
Member

@icemac icemac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly flew over the changes: It is much better than before!


The Add form asks you for an **Id** and a **Title**. Give your
**ZCatalog** the **Id** ``AnimalCatalog`` and click **Add** to create your new
**ZCatalog**. The **ZCatalog** icon looks like a folder with a small
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nowadays with Bootstrap ZMI the folder is gone, the icon is only a magnifying glass.


A **ZCatalog** has the following views: ``Contents``, ``Catalog``,
``Properties``, ``Indexes``, ``Metadata``, ``Find Objects``,
``Advanced``, ``Undo``, ``Security``, and ``Ownership``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently there are Query Report and Query Plan following Advanced. But Undo is no longer there.

Suggested change
``Advanced``, ``Undo``, ``Security``, and ``Ownership``.
``Advanced``, ``Query Report``, ``Query Plan``, ``Security``, and ``Ownership``.

@jugmac00
Copy link
Member Author

@icemac Thanks so much for taking the time to review this pull request!

Thanks for your suggestions. I deliberately did not include them in my pr, as then we'd had a document with mixed Zope 2 (at least screenshots) and Zope 4 (menu items) content, as I missed the time to update the document properly for Zope 4/5.

With #671 we already have an issue for updating the content to Zope 4/5 - I added a comment there which links to this pull request and adds a note to include your suggestions.

@jugmac00 jugmac00 merged commit 1961208 into master Dec 12, 2019
@jugmac00 jugmac00 deleted the update-zcatalog-docu branch December 12, 2019 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants