Skip to content

Commit c431da4

Browse files
committed
Merge branch 'master' of https://github.com/Lauragra/sp-dev-docs
2 parents dfefd70 + 40f91aa commit c431da4

File tree

42 files changed

+2008
-848
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2008
-848
lines changed

docs/apis/communication-site-creation-rest.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
Learn how to create and get the status of a new modern SharePoint Communication site with the REST interface.
44

5-
> [!NOTE]
6-
> There is a known bug with this API which is blocking completely this behavior. Fix will be rolling gradually to SharePoint Online by end of October 2017.
7-
85
## Prerequisites
96

107
This topic assumes that you are already familiar with the topics Get to know the SharePoint REST service and Complete basic operations using SharePoint REST endpoints. It does not provide code snippets.

docs/declarative-customization/column-formatting.md

Lines changed: 1019 additions & 0 deletions
Large diffs are not rendered by default.

docs/declarative-customization/site-theming/sharepoint-site-theming-csom.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Before you get started, make sure that you're familiar with the following:
77
- [Using the Client Object Model](https://msdn.microsoft.com/en-us/library/ff798388.aspx)
88
- [Common Programming Tasks in the Managed Client Object Model](https://msdn.microsoft.com/en-us/library/ee537013.aspx)
99

10-
You will also need to install the [Microsoft.SharePointOnline.CSOM](https://www.nuget.org/packages/Microsoft.SharePointOnline.CSOM/) NuGet package (version 16.1.6906.1200 or later).
10+
You will also need to reference the [Microsoft.SharePointOnline.CSOM](https://www.nuget.org/packages/Microsoft.SharePointOnline.CSOM/) NuGet package (version 16.1.6906.1200 or later).
1111

1212
## CSOM code example
1313

@@ -20,17 +20,19 @@ The following example shows how to create a __Microsoft.Online.SharePoint.Tenant
2020
2121
```C#
2222
using System.Security;
23-
using SPClient=Microsoft.SharePoint.Client;
23+
using Microsoft.SharePoint.Client;
2424
using Microsoft.Online.SharePoint.TenantAdministration;
2525
using Microsoft.Online.SharePoint.TenantManagement;
2626

27-
SPClient.ClientContext ctx = new SPClient.ClientContext("https://mysite-admin.sharepoint.com/");
27+
...
28+
29+
ClientContext ctx = new ClientContext("https://mysite-admin.sharepoint.com/");
2830
var pwd = "mypassword";
2931
var passWord = new SecureString();
3032
foreach (char c in pwd.ToCharArray()) passWord.AppendChar(c);
31-
ctx.Credentials = new SPClient.SharePointOnlineCredentials("[email protected]", passWord);
33+
ctx.Credentials = new SharePointOnlineCredentials("[email protected]", passWord);
3234
Tenant tenant = new Tenant(ctx);
33-
SPClient.ClientObjectList<ThemeProperties> themes = tenant.GetAllTenantThemes();
35+
ClientObjectList<ThemeProperties> themes = tenant.GetAllTenantThemes();
3436
```
3537

3638
## Theme definition example
@@ -69,7 +71,7 @@ public class SPOTheme 
6971

7072
## Applying a theme
7173

72-
The methods described in this section are used to manage the available themes in your tenant. To _apply_ a theme to a particular SharePoint website, use the [SPWeb.ApplyTheme](https://msdn.microsoft.com/en-us/library/office/jj251358.aspx) method of the [Microsoft.SharePoint.Client.Web](https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.web.aspx) class.
74+
There's currently no supported API to programmatically apply a theme to specific site.
7375

7476
## Methods/properties of the Microsoft.Online.SharePoint.TenantAdministration.Tenant class
7577

@@ -118,7 +120,7 @@ __Return type:__ ClientResult<bool>
118120

119121
## Methods of the Microsoft.Online.SharePoint.TenantManagement.Tenant class
120122

121-
Use the following methods to manage themes in a multitenant environment.
123+
These are alternative APIs to manage your themes in tenant level.
122124

123125
### AddTenantTheme public method
124126
Add a theme to the tenant.

docs/declarative-customization/site-theming/sharepoint-site-theming-powershell.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -124,20 +124,6 @@ C:\> Get-SPOTheme -Name "Custom Cyan" | ConvertTo-Json
124124
```
125125
Note that this example uses the PowerShell _ConvertTo-Json_ filter to display the theme in JSON format.
126126

127-
To see all the themes currently available in the tenant store, use **Get-SPOTheme** with no arguments.
128-
129-
```powershell
130-
c:\> Get-SPOTheme
131-
Blue
132-
Orange
133-
Red
134-
Purple
135-
Green
136-
Gray
137-
Dark Yellow
138-
Dark Blue
139-
Custom Cyan
140-
```
141127
## Remove-SPOTheme
142128

143129
The **Remove-SPOTheme** cmdlet removes a theme from your tenant store. For example, this cmdlet removes the "Custom Cyan" theme that was used in the previous examples.

docs/declarative-customization/site-theming/sharepoint-site-theming-rest-api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,3 +133,4 @@ RestRequest("/_api/thememanager/GetTenantThemingOptions");
133133
* [SharePoint site theming: CSOM](sharepoint-site-theming-csom.md)
134134
* [Complete basic operations using SharePoint REST endpoints](https://dev.office.com/sharepoint/docs/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints.md)
135135
* [Making REST calls with C# and JavaScript for SharePoint 2013](http://www.microsoft.com/resources/msdn/en-us/office/media/video/video.mdl?cid=sdc&from=mscomsdc&VideoID=4e4cc094-ff69-405b-852f-2ac7c41293c5)
136+

docs/design/accessibility.md

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
title: Accessibility in SharePoint web part design
3+
ms.date: 9/25/2017
4+
---
5+
6+
<!--Based on how rough this content is in it's current state, i'm going to pull it from this initial release so we can edit and better prepare. -->
7+
8+
9+
10+
11+
# Accessibility in SharePoint web part design
12+
13+
Developing an equal experience that meets all users' unique visual, hearing, dexterity, cognitive, and speech needs is an important component of SharePoint web part design. Accessible design applies not only to people with disabilities, but also to potential situational impairments. Accessible design is good design.
14+
15+
## Accessibility guidelines
16+
17+
<!-- Make sure that this is an external resource that folks can access. Original link was to a OneNote file. -->
18+
All Microsoft products must meet the requirements listed in the [Microsoft Accessibility Standards](https://microsoft.sharepoint.com/teams/msenable/Pages/MASDetails.aspx
19+
"Link to Microsoft Accesssibility Standards").
20+
21+
<!-- Fabric components are not designed to be accessible already? And, shouldn't components that aren't based on Fabric also be accessible? -->
22+
23+
If you're building a dialog box, file picker, or any other [Office UI Fabric](https://dev.office.com/fabric#/components) component, follow the guidance in this article to ensure that your content is accessible.
24+
25+
<!-- Not sure why we have that link? It currently goes to the OneNote file. Where is the Common UI Controls content? Is that related to accessibility? -->
26+
27+
[Common UI Controls](https://microsoft.sharepoint.com/teams/STS/_layouts/OneNote.aspx?id=%2Fteams%2FSTS%2FShared%20Documents%2FSP%20Accessibility%2FAccessibility%20Guidance&wd=target%28Accessibility%20101.one%7C0005C142-938C-4411-B543-B9F4199E19B3%2FEverything%20you%20need%20to%20know%20about%20Accessibility%7CE099AFE3-8804-4E1F-BA50-99493AB8A3D0%2F%29 "Link to Common UI Controls")
28+
29+
## Accessibility testing
30+
31+
<!-- FYI, I added links. Can we assume that our target audience uses the Edge browser? -->
32+
33+
Test your web part first with [Narrator](https://support.microsoft.com/en-us/help/22798/windows-10-narrator-get-started) and Microsoft Edge, and then verify the accessibility experience with [JAWS](http://www.freedomscientific.com/Products/Blindness/JAWS).
34+
35+
Narrator and Microsoft Edge are standards compliant. When you test with that combination, you are more likely to find issues, and you can validate that your site meets accessibility standards.
36+
37+
JAWS is the market leader in screen readers. JAWS includes features that can improve the accessibility of some websites that aren't as accessible in other screen readers. Therefore testing in JAWS might not ensure that your site meets all accessibility requirements.
38+
 
39+
You might also want to test for whatever combination of browser and screen reader has the greatest market share for your website.
40+
41+
<!-- Delete? This doesn't seem like text that should be in externally published docs?
42+
When suppliers test with JAWS, we ask them to repro identified bugs with Narrator and Edge. In the case a bug does not repro with Narrator/Edge it is sent to Mary Smith who works with VFO for a Jaws specific fix.
43+
-->
44+
45+
## Keyboard navigation
46+
47+
<!-- Is this section telling people how to navigate via a keyboard, or how to design to optimize for keyboard navigation? If the former, . -->
48+
49+
For some users, navigating a site via keyboard is more accessible. Power users also often rely on keyboard navigation. Use keyboard shortcuts such as tabs to go controls on the page, and use arrow keys to navigate inside controls.
50+
51+
### Navigation between controls
52+
53+
Each control is a tab stop. Within a control, the following rules apply:
54+
55+
- In general, the first tab stop is the top left area of the control. The last tab stop is the bottom right control.
56+
- For modal surfaces, the last tab stop should be the commit actions.
57+
- For lists, the first tab stop should be the first item in the list, the next should be the commands, and then the navigation, settings, and so on.
58+
59+
<!-- We should make sure the content in the accessibility topic is accessibible. ;) Please describe the information that the image conveys; something like this (also consider making the image an actual screen shot, that might be more clear):
60+
61+
In the following image:
62+
The first tab is the list item.
63+
The second tab is the command.
64+
The third tab is the navigation.
65+
-->
66+
![Image that shows the tab stops on a SharePoint page](https://i.imgur.com/Vn3VosN.png)
67+
68+
### Navigation within a control
69+
70+
You can use arrow keys to move to items in a control, such as choices in a menu, commands in a command bar, or items in a list.
71+
72+
<!-- This image is not very clear. Do you need to have the "blank" list box on the left? -->
73+
74+
![Using arrow keys to navigate within a control](https://i.imgur.com/vF0Nk73.png)
75+
76+
### Selecting the current item
77+
78+
Use the space bar to select or deselect the item currently in focus in a control.
79+
80+
![Using the space bar to select an item in a list](https://i.imgur.com/j3fBKPl.png)
81+
82+
### Run a control
83+
84+
Press **Enter** or the return key to run a control.
85+
86+
![Press enter to run a control](https://i.imgur.com/s0nMPdT.png)
87+
88+
### Leave a control
89+
90+
Press **Escape** to exit a control and return to the container.
91+
92+
![Pressing Escape to leave a control and return to the container](https://i.imgur.com/uD99zIX.png)
93+
94+
### Go to the first or last item
95+
96+
Press **Home** or **End** to go directly to the first or last item in a list, menu, and so on.
97+
98+
![Pressing Home or End to go to the first or last item in a list](https://i.imgur.com/gGKsh74.png)
99+
100+
101+
## Screen reader navigation
102+
103+
Users who have vision impairments rely on screen readers to navigate the site UI.
104+
105+
<!-- Narrator isn't a third-party product. This image needs more text/explanation; please also clarify the alt text. Is this section important, or can it be removed, given the previous mention of testing with Narrator and JAWS? Again, the intent/target audience for this information isn't clear - is it for the user, or the designer? Can you explain why this information is important from the designer's POV? -->
106+
107+
![Screen reader navigation of a SharePoint page](https://i.imgur.com/ar23o3X.png)
108+
109+
## Alt text and transcripts
110+
111+
Use alt text to provide descriptions of images that can be consumed by screen readers. This is useful for vision-impaired users who cannot consume information visually. Make sure that your alt text is descriptive, keeping in mind that some readers are relying on a screen reader to access the information conveyed in the image.
112+
113+
Don't rely only on color to convey meaning; rely on both color and shape.
114+
115+
To be fully compliant with accessibility standards, include alt text and a complete transcript of audio and video content on your site.
116+
117+
## Minimum readable contrast
118+
119+
A minimum level of contrast is essential to help users with vision impairments consume the content on the page. It is also important to aid readability in low light and glare situations.
120+
121+
<!-- Convert this image into a table, for accessibility. ;) -->
122+
123+
![Neutral, Theme, and Alert colors for minimum readable contrast](https://i.imgur.com/L7pSF1w.png)
124+
125+
126+
## High contrast
127+
128+
Use high contrast colors as a guide for color choices for components and states on the web. Windows computers only have the ability to detect whether a PC is running high contrast, or high contrast white. For this reason, use the default high contrast black setting for any high contrast, non-white theme.
129+
130+
<!-- In the left part of the image, I think the title should be "High Contrast Black". -->
131+
132+
![High contrast black and high contrast white settings](https://i.imgur.com/qvTFzd4.png)
133+
134+
135+
136+
137+

0 commit comments

Comments
 (0)