Skip to content

Document formatting dialog (issue #6348)#6402

Closed
feerrenrut wants to merge 3 commits into
fixGuiAlignmentIssuesfrom
i6348-documentFormattingDialog
Closed

Document formatting dialog (issue #6348)#6402
feerrenrut wants to merge 3 commits into
fixGuiAlignmentIssuesfrom
i6348-documentFormattingDialog

Conversation

@feerrenrut

@feerrenrut feerrenrut commented Sep 23, 2016

Copy link
Copy Markdown
Contributor

This address the issue that the document formatting options dialog can be too long to fit on some screens. To resolve this the formatting options have been put into a scrollable section, the options have been grouped by similarity, and some dialog text has been added to explain the dialog better.

Fixes #6348

@feerrenrut

Copy link
Copy Markdown
Contributor Author

@jcsteh, would you mind reviewing this?

@jcsteh jcsteh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

source/gui/settingsDialogs.py.orig seems to have been added (unless GitHub is doing something odd?) and should be removed.

Thanks!

Comment thread source/gui/guiHelper.py
raise NotImplementedError("Use addLabeledControl instead")

if isinstance(toAdd, wx.StaticBoxSizer):
if isinstance(toAdd, (wx.StaticBoxSizer, scrolledpanel.ScrolledPanel)):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Similar query in #6287: should this be an elif?

Comment thread source/gui/settingsDialogs.py Outdated
title = _("Document Formatting")

def makeSettings(self, settingsSizer):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: Extraneous blank line?

Comment thread source/gui/settingsDialogs.py Outdated
# Translators: This is the label for a group of document formatting options in the
# document formatting settings dialog
otherGroupText = _("Elements")
otherGroup = guiHelper.BoxSizerHelper(scrolledItems, sizer=wx.StaticBoxSizer(wx.StaticBox(scrolledItems, label=otherGroupText), wx.VERTICAL))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this should be renamed to elementsGroup given the label change to Elements.

Comment thread source/gui/settingsDialogs.py Outdated

sHelper.addItem(scrolledItems)
scrolledItems.Layout()
scrolledItems.SetupScrolling()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is also called above when creating the panel. Are both these calls necessary?

Comment thread source/gui/settingsDialogs.py Outdated
scrolledItems.SetupScrolling()
self.scrolledItems = scrolledItems
checkboxItems = guiHelper.BoxSizerHelper(scrolledItems, orientation=wx.VERTICAL)
checkboxItemsBorder = wx.BoxSizer(wx.VERTICAL)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

checkboxItems does mostly contain check boxes, but the line indentation setting is a choice control, not a check box. Therefore, I think this should be renamed, as I'm concerned it might be misleading in future. Maybe we could call this scrolledItems and rename the panel to scrolledPanel?

Comment thread user_docs/en/userGuide.t2t Outdated
- Landmarks
- Frames
- When something is clickable
The document formatting options are organised into groups, you can configure reporting of:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please split this into two sentences:

The document formatting options are organised into groups.
You can configure reporting of:

feerrenrut added a commit that referenced this pull request Sep 27, 2016
feerrenrut added a commit that referenced this pull request Sep 29, 2016
For issue: #6348
Merge branch 'i6348-documentFormattingDialog' into next

Conflicts:
	source/gui/guiHelper.py
	source/gui/settingsDialogs.py
	user_docs/en/userGuide.t2t
@nvaccessAuto nvaccessAuto assigned feerrenrut and unassigned jcsteh Sep 29, 2016
The document formatting settings dialog is restructured so that items
can no longer "disappear" off the screen. The options are now in a
scrolling section, grouped for clarity (paritcularly for new users /
sighted users). A dialog description has been added, for further
clarity.
Updated the user guide, and some small wording changes.
@feerrenrut feerrenrut force-pushed the i6348-documentFormattingDialog branch from d4879e2 to 6278636 Compare October 4, 2016 04:51
@LeonarddeR

Copy link
Copy Markdown
Collaborator

I like these changes, however when tabbing through the dialog, I think it is unclear that "Report formatting changes after the cursor" is an option that doesn't belong to any grouping. That is, when you tab through the elements grouping and reach the after the cursor option, no other grouping is announced. So, people might possibly think that they're still in the elements grouping.

@jcsteh

jcsteh commented Oct 13, 2016 via email

Copy link
Copy Markdown
Contributor

@LeonarddeR

Copy link
Copy Markdown
Collaborator

Agreed. Another possibility would be putting back the option as first in the tab order, but, it is not that important really. I came across it and thought, let's report this in case you guys would like to account for it.

@jcsteh

jcsteh commented Oct 13, 2016 via email

Copy link
Copy Markdown
Contributor

feerrenrut added a commit that referenced this pull request Oct 13, 2016
Merges in branches
- 'i6101_SymbolsListCtrl'
- 'i6348-documentFormattingDialog'
- 'fixGuiAlignmentIssues'

Adjust the symbols list. See PR #6339

    Put the 'symbol' label above the list and have the list itself take up
    the full width of the dialog. Columns are spaced automatically, with one
    nominated to take up any extra available room.

    The first column was selected to expand more, as the information in the
    other columns can be viewed in the "change symbol" group.

    Fixes #6101

Restructure the document formatting dialog. See PR #6402

    The document formatting settings dialog is restructured so that items
    can no longer "disappear" off the screen. The options are now in a
    scrolling section, grouped for clarity (paritcularly for new users /
    sighted users). A dialog description has been added, for further
    clarity.

    Fixes #6348

Fix Gui Alignment issues. See PR #6287

    Fixes up various alignment and padding problems in the GUI.
    Introduces a new helper to abstract some of these details.

    Fixes #6317 (Gestures treeview does not look like a treeview)
    Fixes #5548 (Text control to specify the path when creating a portable copy is quite narrow)
    Fixes #6342 (Spacing between labels and combo boxes)
    Fixes #6343 (Inconsistency with vertical spacing between checkbox/label options)
    Fixes #6349 (input gestures dialog tree view too small)
@feerrenrut

Copy link
Copy Markdown
Contributor Author

This has been merged into master with commit: 87ed4d1

@feerrenrut feerrenrut closed this Oct 13, 2016
feerrenrut added a commit that referenced this pull request Oct 13, 2016
For PR #6287 - Various padding and alignment issues have been resolved. (#6317, #5548, #6342, #6343, #6349)
For PR #6402 - The document formatting dialog has been adjusted so that the contents scrolls. (#6348)
For PR #6339 - Adjusted the layout of the symbols pronunciation dialog so the full width of the dialog is used for the symbols list. (#6101)
@feerrenrut feerrenrut added this to the 2016.4 milestone Oct 13, 2016
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.

4 participants