Changes for page Readability Guidelines

Last modified by Lizzie Bruce on 2020/01/12 00:10

From version 1.1 Icon
edited by Thomas Mortagne
on 2019/02/28 10:30
Change comment: Copied from template:Main.WebHome
To version Icon 1.2 Icon
edited by Lizzie Bruce
on 2019/03/06 12:54
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Home
1 +Readability Guidelines
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.ThomasMortagne
1 +xwiki:XWiki.LizzieBruce
Content
... ... @@ -1,47 +1,54 @@
1 1  {{box cssClass="floatinginfobox"}}
2 -{{velocity}}
3 -{{html clean="false"}}
4 -## Chrome's XSS Auditor blocks the preview action if:
5 -## * the submitted content has an iframe with an external URL
6 -## * the preview action displays the submitted iframe
7 -## The workaround is to make sure the submitted content (the macro markers) don't match the preview HTML.
8 -## See XWIKI-14818: Preview triggers ERR_BLOCKED_BY_XSS_AUDITOR in Chrome
9 -#set ($iframe = 'iframe')
10 -<$iframe src="https://www.youtube.com/embed/9QTWrZ7OfzI" allowfullscreen></$iframe>
11 -{{/html}}
12 -{{/velocity}}
2 +
13 13  {{/box}}
14 14  
15 -= Welcome to your wiki =
5 +A [[collaborative project>>url:https://contentdesign.london/blog/usability/readability-guidelines]] to develop inclusive, universal style guidance, created by Sarah Richards at Content Design London.
16 16  
17 -XWiki is the best tool to organize your knowledge. A //wiki// is organized in a hierarchy of //pages//. You can create multiple wikis, each with its own set of pages.
7 +== Get involved ==
18 18  
19 -XWiki can be used as a knowledge base (support, documentation, sales, etc.), for collaborative workspaces or even as a complete intranet.
9 +Explore and contribute:
20 20  
21 -= The basics =
11 +* (((
12 +watch the London Accessibility MeetUp [[Readability Guidelines talk>>url:https://www.youtube.com/watch?v=PQzdtE8JQOs]]
13 +)))
14 +* (((
15 +read the Slack discussions: [[readabilityguidelines.slack.com>>url:https://readabilityguidelines.slack.com/]], join: [[bit.ly/2D0OW1F>>url:https://bit.ly/2D0OW1F]]
16 +)))
17 +* (((
18 +share usability studies and academic research evidence on this wiki
19 +)))
20 +* (((
21 +follow #ReadabilityGuidelines on Twitter and LinkedIn
22 +)))
22 22  
23 -To make the most out of your wiki, log-in and:
24 +== Alpha ==
24 24  
25 -Use the {{velocity}}$services.icon.render('pencil'){{/velocity}} button above to //edit// this page and start customizing your wiki to your needs.
26 +The Readability Guidelines Alpha explored:
26 26  
27 -Use the {{velocity}}$services.icon.render('add'){{/velocity}} button above to //add// more pages to your wiki and create the //hierarchy// that best organizes your content.
28 +* (((
29 +if an open community of content people want to contribute to a single style guide
30 +)))
31 +* (((
32 +if we'd like to rely on evidence for the style guide elements – and if yes, what evidence would be most useful
33 +)))
34 +* (((
35 +if a wiki model is sustainable
36 +)))
28 28  
29 -Use the {{velocity}}$services.icon.render('home'){{/velocity}} breadcrumbs located above the title to //navigate// inside your pages. It's easy to get lost in a big wiki without them.
38 +Read the [[first Readability Guidelines blog post>>url:https://contentdesign.london/blog/usability/readability-guidelines]].
30 30  
31 -You can also use the [[Sandbox>>Sandbox.WebHome]] for more demo content and generally a place to experiment with your wiki's features.
40 +Alpha ran from July to October, 2018.
32 32  
33 - {{box}}Learn more on how to use XWiki with the {{velocity}}[[Getting Started Guide>>http://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/GettingStarted/WebHome?version=$xwiki.version]]{{/velocity}}.{{/box}}
42 +== Beta ==
34 34  
35 -|(((
36 -= Extend your wiki =
44 +Beta was October to December 2018. We identified [[17 usability questions>>url:https://app.nuclino.com/Content-Design-London/Readability-Guidelines/Usability-questions-a01f6825-982e-4152-abcd-02801c2f63a7]] in Alpha and researched usability evidence to answer them in Beta.
37 37  
38 -To extend the power and functionalities of your wiki with the features that //you// need, head over to the {{velocity}}[[Extension Manager>>path:$xwiki.getURL($services.model.createDocumentReference('wiki', 'XWiki', 'XWikiPreferences'), 'admin', 'editor=globaladmin&section=XWiki.Extensions')]]{{/velocity}} where you can search for and install extensions.
46 +Read the final [[Beta blog update>>url:https://contentdesign.london/content-process/readability-guidelines-beta-update-4-by-lizzie-bruce/]].
39 39  
40 -To browse through the 900+ community contributed extensions available for XWiki, head over to the [[Extensions Repository>>http://extensions.xwiki.org]].
41 -)))|(((
42 -= Create your application =
48 +Through the 24 weeks of Alpha and Beta we held live weekly, global discussions in Slack. We have almost 500 members in our Slack community.
43 43  
44 -Go beyond the available extensions and define the //structure// of your data based on //your// needs, creating //your// own applications with [[App Within Minutes>>AppWithinMinutes]] (AWM).
50 +== Contributing ==
45 45  
46 -AWM will take care of making it easy for you and your users to create and manage the data.
47 -)))
52 +This is a totally open project. As long as all participation is respectful and comments are given in the spirit of positive open learning – dive in! Any comments or queries outside of this wiki, please get in touch on twitter [[@ContentDesignLN>>url:https://readabilityguidelines.slack.com]].
53 +
54 +You are welcome to edit, comment on or create wiki pages. Please include evidence to support your thinking.