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

added documentation about zope4 ZMI template updating #329

Merged
merged 7 commits into from
Oct 2, 2018
Merged

Conversation

drfho
Copy link
Contributor

@drfho drfho commented Oct 1, 2018

please check comprehensibility, thanks Frank

Copy link
Contributor

@dwt dwt left a comment

Choose a reason for hiding this comment

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

Looks mostly good, some small stuff that should be changed before merge.

docs/ZMI.rst Outdated
typical bootstrap class names like ``text-warning``.

**Icons:**
Zope4 object classes which are show in the ZMI have declared a global variable
Copy link
Contributor

Choose a reason for hiding this comment

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

My understanding is that these are instance variables? Is Zope Speak here different to standard python?

docs/ZMI.rst Outdated
ZPT-Example see: ``../Zope/src/Products/PageTemplates/www/ptEdit.zpt``

**File upload element:**
The file upload element has an own form container (classfied as ``zmi-upload``).
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe "it's own form container" could be more fluid.

docs/ZMI.rst Show resolved Hide resolved
docs/ZMI.rst Outdated
Bootstraps requires an explictit CSS class ``table`` for any table; espcially
long item lists should get an additional CSS class ``table-sm`` and maybe another
class ``table-striped`` for a better readability. Finally it is recommended
to add a specific identifying class name. The table structure is
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems to be missing part of the sentence

Copy link
Member

@sallner sallner left a comment

Choose a reason for hiding this comment

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

The text reads fine and with the reference to the files and the examples, it should be possible to port old templates. There are some typos and syntax errors in the examples, so it would be nice, if that would be fixed before merging.

docs/ZMI.rst Outdated
Update your Zope2 ZMI template code
+++++++++++++++++++++++++++++++++++

The Zope4 ZMI uses some basic CSS class names of the bootstrap cCSS framework
Copy link
Member

Choose a reason for hiding this comment

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

is this a typo CSS framework?

docs/ZMI.rst Outdated
fowllowing the typical element nesting:
any form element has a bootstrap-like form-group structure containing a label
and an input field. Important: the width of the input field is defined by the
nesting div-container using the responsive grid classes ``col-sm-9 col-and md-10``.
Copy link
Member

Choose a reason for hiding this comment

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

The grid classes should rather be col-sm-9 col-md-10 as in the example.

docs/ZMI.rst Outdated
prefixed ``zmi-`` whereas the basic layout is done by usual bootstrap classes
fowllowing the typical element nesting:
any form element has a bootstrap-like form-group structure containing a label
and an input field. Important: the width of the input field is defined by the
Copy link
Member

Choose a reason for hiding this comment

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

_T_he width of the input field...

docs/ZMI.rst Outdated
and an input field. Important: the width of the input field is defined by the
nesting div-container using the responsive grid classes ``col-sm-9 col-and md-10``.
The input field width is completed to 12 (=100%) by the preceeding label classes
``col-sm-3`` and ``col-md-2``
Copy link
Member

Choose a reason for hiding this comment

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

Maybe:

With the classes ``col-sm-3 col-md-2`` for the label, a complete bootstrap row of 12 is filled.

docs/ZMI.rst Outdated
<label for="title" class="form-label col-sm-3 col-md-2">Title</label>
<div class="col-sm-9 col-md-10">
<input id="title" class="form-control" type="text" name="title"
value="<dtml-if title>&dtml-title;</dtml-if>" />
Copy link
Member

Choose a reason for hiding this comment

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

one space before value= could be deleted.

docs/ZMI.rst Show resolved Hide resolved
docs/ZMI.rst Outdated

**File upload element:**
The file upload element has it's own form container (classfied as ``zmi-upload``).
All subseqeunt elements are nested as 'input-group' containing a div classified as
Copy link
Member

Choose a reason for hiding this comment

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

subseq_ue_nt ... ``input-group`` as you used this notation for all CSS-classes

docs/ZMI.rst Outdated
supplied by the Fontawsome web font (https://fontawesome.com/icons)

**Tables:**
Bootstraps requires an explictit CSS class ``table`` for any table; espcially
Copy link
Member

Choose a reason for hiding this comment

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

Bootstrap__ ... explic__it ... esp_e_cially

docs/ZMI.rst Outdated
bootstrap standard table (https://getbootstrap.com/docs/4.1/content/tables/).

**ZMI-classes:**
All basic stylings of the zmi-elements are defined in the CSS file, see:
Copy link
Member

Choose a reason for hiding this comment

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

one whitespace ... zmi-elements_ _are

docs/ZMI.rst Outdated
Bootstraps requires an explictit CSS class ``table`` for any table; espcially
long item lists should get an additional CSS class ``table-sm`` and maybe another
class ``table-striped`` for a better readability. Finally it is recommended
to add a specific identifying class name. The table structure is compliant to
Copy link
Member

Choose a reason for hiding this comment

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

can you please give an example for such a name?

@icemac icemac added this to In progress in Zope 4 final release via automation Oct 2, 2018
@icemac icemac added this to the 4.0 final milestone Oct 2, 2018
Zope 4 final release automation moved this from In progress to Reviewer approved Oct 2, 2018
@dwt dwt merged commit 655812b into master Oct 2, 2018
Zope 4 final release automation moved this from Reviewer approved to Done Oct 2, 2018
@dwt dwt deleted the docs_zmi branch October 2, 2018 12:17
@icemac icemac modified the milestones: 4.0 final, 4.0b6 Oct 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants