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.

Sign up for GitHub

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

Jump to bottom

ListDetailsView Two-pane view documentation update #559

Merged
merged 3 commits into from
Sep 17, 2021
Merged

ListDetailsView Two-pane view documentation update #559

merged 3 commits into from
Sep 17, 2021

Conversation

COM8
Copy link
Contributor

@COM8 COM8 commented Aug 23, 2021 •
edited
Loading

Fixes #

Docs for Toolkit PR #4197

What changes to the docs does this PR provide?

Adds documentation for the updated ListDetailsView using the Two-pane view as underlying control now.
Also adds documentation for the following new properties: DetailsPaneBackground, DetailsContentTemplateSelector, ListPaneNoItemsContent, ListPaneNoItemsContentTemplate and ListPaneItemTemplateSelector

PR Checklist

Please check if your PR fulfills the following requirements:

  • Correctly picked the right branch to base the change off (dev for new features, master for typos/improvements)
  • For new pages, used the provided template
  • For new features, added an entry in the Table of Contents
  • Ran against a spell and grammar checker
  • Contains NO breaking changes

Other information

@COM8 COM8 mentioned this pull request Aug 23, 2021
Closed
@opbld33
Copy link

opbld33 commented Aug 23, 2021

Docs Build status updates of commit e6caed3:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
dotnet/xml/Microsoft.Toolkit.Uwp.UI.Controls/ListDetailsView.xml ❌Error Details
❌Error Details

dotnet/xml/Microsoft.Toolkit.Uwp.UI.Controls/ListDetailsView.xml

  • Line 0, Column 0: [Error-ECMA2Yaml_InternalError]
Intenal Several Error: System.Xml.XmlException: The 'Type' start tag on line 1 position 2 does not match the end tag of 'Members'. Line 1107, position 5.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.XmlTextReaderImpl.Read()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r, LoadOptions o)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)
  • Line 0, Column 0: [Error-ECMA2Yaml_InternalError]
Intenal Several Error: System.Xml.XmlException: The 'Type' start tag on line 1 position 2 does not match the end tag of 'Members'. Line 1107, position 5.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

  • Line 0, Column 0: [Error-ECMA2Yaml_File_LoadFailed] Failed to load 1 files, aborting...
  • Line 0, Column 0: [Error-ECMA2Yaml_File_LoadFailed] Failed to load 1 files, aborting...

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@COM8 COM8 mentioned this pull request Aug 23, 2021
Closed
8 tasks
@COM8 COM8 marked this pull request as ready for review August 23, 2021 08:28
@opbld31
Copy link

opbld31 commented Aug 23, 2021

Docs Build status updates of commit 99aa708:

⚠️ Validation status: warnings

File Status Preview URL Details
dotnet/xml/Microsoft.Toolkit.Uwp.UI.Controls/ListDetailsView.xml ⚠️Warning View Details
docs/controls/MasterDetailsView.md 💡Suggestion View Details
dotnet/xml/FrameworksIndex/win-comm-toolkit-dotnet-7.0.xml ✅Succeeded

dotnet/xml/Microsoft.Toolkit.Uwp.UI.Controls/ListDetailsView.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Media.Brush'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelector'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelector'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.CommandBar'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.CommandBar'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DataTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelector'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelector'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.ItemsControl'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.CommandBar'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackground'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContent'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.TemplatePartAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DataTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.TemplateVisualStateAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.ItemsControl'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackground'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.SelectionChangedEventHandler'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DataTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.CommandBar'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContent'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DataTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.

docs/controls/MasterDetailsView.md

  • Line 35, Column 25: [Suggestion-docs-link-absolute] Absolute link 'https://docs.microsoft.com/windows/uwp/design/controls-and-patterns/two-pane-view' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@COM8
Copy link
Contributor Author

COM8 commented Aug 23, 2021

How can I convert 'https://docs.microsoft.com/windows/uwp/design/controls-and-patterns/two-pane-view' to a relative link?
Would this then be something like: windows/uwp/design/controls-and-patterns/two-pane-view?

Can I do anything to fix those warnings?

@XAML-Knight
Copy link
Contributor

How can I convert 'https://docs.microsoft.com/windows/uwp/design/controls-and-patterns/two-pane-view' to a relative link?
Would this then be something like: windows/uwp/design/controls-and-patterns/two-pane-view?

yes, for a relative URL, try /windows/uwp/design/controls-and-patterns/two-pane-view (this is similar to other controls' documentation, in the toolkit)

@opbld32
Copy link

opbld32 commented Aug 25, 2021

Docs Build status updates of commit bc134c8:

⚠️ Validation status: warnings

File Status Preview URL Details
dotnet/xml/Microsoft.Toolkit.Uwp.UI.Controls/ListDetailsView.xml ⚠️Warning View Details
docs/controls/MasterDetailsView.md ✅Succeeded View
dotnet/xml/FrameworksIndex/win-comm-toolkit-dotnet-7.0.xml ✅Succeeded

dotnet/xml/Microsoft.Toolkit.Uwp.UI.Controls/ListDetailsView.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DataTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.ItemsControl'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.CommandBar'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.CommandBar'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelector'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackground'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelector'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContent'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.TemplatePartAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.TemplateVisualStateAttribute'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.ItemsControl'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Media.Brush'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DataTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneItemTemplateSelector'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContentTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DataTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsPaneBackground'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DataTemplate'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.CommandBar'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.CommandBar'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.Controls.SelectionChangedEventHandler'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.ListPaneNoItemsContent'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Windows.UI.Xaml.DependencyProperty'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'Microsoft.Toolkit.Uwp.UI.Controls.ListDetailsView.DetailsContentTemplateSelector'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@COM8 COM8 mentioned this pull request Aug 27, 2021
Merged
8 tasks
@michael-hawker
Copy link
Collaborator

All the XML stuff is auto-generated, so it doesn't have to be edited, we have a discussion open with the doc team about why we're seeing all the warnings across doc sets; we have invalid configuration somewhere. i.e. it'll get overwritten when we re-generate anyway. So we only need to worry about updating the markdown file. Looks good though. Thanks!

@michael-hawker michael-hawker changed the base branch from dev/7.1.0 to master September 16, 2021 22:17
@michael-hawker michael-hawker added this to the 7.1 milestone Sep 16, 2021
@XAML-Knight XAML-Knight merged commit 461ca9d into MicrosoftDocs:master Sep 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@XAML-Knight XAML-Knight XAML-Knight approved these changes

Assignees
No one assigned
Labels
Ready for Review ✋
Projects
None yet
Milestone
7.1
Development

Successfully merging this pull request may close these issues.
6 participants
@COM8 @opbld33 @opbld31 @XAML-Knight @opbld32 @michael-hawker