You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-25Lines changed: 29 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,25 +4,29 @@
4
4
#adapt-aboutUs
5
5
6
6
An Adapt extension that adds to the Drawer information about the sponsoring organization.
7
-

7
+

8
8
9
-
##In Progress
9
+
##Usage
10
10
11
-
It works, but not yet ready for installation through the authoring tool. Hasn't been thoroughly tested, but then again, it's not too complex.
11
+
This extension adds an item to the Drawer. All text is replaceable/customizable. Graphic/logo that appears in front of the organization is optional. Social links are optional, but are restricted to the icons available within the extension (see list below). Between the name of the organization and the social links, any number of title/description items maybe configured. The above titles ("Our Mission," "Contact Us," "Find Us," "Partner with Us") are simply examples. What is seen in the image above is simply an example.
12
12
13
-
##Issues
13
+
##Installation
14
14
15
-
- Installation requires the included fonts to be moved manually to build/adapt/css/fonts. This will not be necessary with framework v2.0.
16
-
- ex-logo.png is an example logo that can be moved into place in src/course/en/images
17
-
- Accessibility has not been addressed.
15
+
* With the [Adapt CLI](https://github.com/adaptlearning/adapt-cli) installed, run the following from the command line:
16
+
`adapt install adapt-aboutUs`
18
17
19
-
##Usage
18
+
Alternatively, this component can also be installed by adding the following line of code to the *adapt.json* file:
19
+
`"adapt-aboutUs": "*"`
20
+
Then running the command:
21
+
`adapt install`
22
+
(This second method will reinstall all plug-ins listed in *adapt.json*.)
20
23
21
-
This extension adds an item to the Drawer. All text is replaceable/customizable. Graphic/logo that appears in front of the organization is optional. Social links are optional, but are restricted to the icons available within the extension (see list below). Between the name of the organization and the social links, any number of title/description items maybe configured. The above titles ("Our Mission," "Contact Us," "Find Us," "Partner with Us") are simply examples. What is seen in the image above is simply an example.
24
+
***About Us** may be installed using [Plugin Management](https://github.com/adaptlearning/adapt_authoring/wiki/Plugin-Manager).
25
+
<divfloatalign=right><ahref="#top">Back to Top</a></div>
22
26
23
-
##Settings overview
27
+
##Settings Overview
24
28
25
-
An complete example of this extension's settings can be found in the [example.json](https://github.com/chucklorenz/adapt-aboutUs/blob/master/example.json) file. These settings are to be configured in the `course.json` file.
29
+
The attributes listed below are used in *course.json* to configure **About Us**, and are properly formatted as JSON in [*example.json*](https://github.com/chucklorenz/adapt-aboutUs/blob/master/example.json).
26
30
27
31
####_aboutUs
28
32
@@ -32,25 +36,26 @@ The name of the extension object as used in the `course.json` file.
32
36
33
37
The short texts that appear when the Drawer opens. They link to the example view seen in the image above.
34
38
39
+
####headline
40
+
41
+
The text of the first line that appears to the right of the optional graphic. Typically this would be the name of the organization/company. Its width is set to 87% in order to accommodate the `_graphic`. It expands to 100% when no `_graphic.src` is provided. This style can be altered in `aboutUs.less`.
42
+
35
43
####_graphic
36
44
37
-
The optional image that appears to the left of the organization's name (i.e., the `headline`). An example image is included (ex-logo.png). Its dimensions are 30px x 30px.
45
+
The optional image that appears to the left of the organization's name (the `headline`). *An example image is included (ex-logo.png). Its dimensions are 30px x 30px.*
38
46
39
47
>#####src
40
-
>The path to the image. If it is not provided, no image will be displayed.
48
+
>The path to the image. If it is not provided, no image will be displayed.
49
+
41
50
>#####alt
42
51
>The content of image's `alt` attribute.
43
-
>#####title
44
-
>The content of image's `title` attribute.
45
-
46
-
####headline
47
-
The text of the first line that appears to the right of the optional graphic. Typically this would be the name of the organization/company. Its width is set to 87% in order to accommodate the `_graphic`. It expands to 100% when no `_graphic.src` is provided. This style can be altered in `aboutUs.less`.
48
52
49
53
####_aboutUsItems
50
-
A list of any number of title/description pairs that appears between the company name and the social links.
54
+
A list of any number of title/description text pairs that appears between the company name and the social links.
51
55
52
56
>#####title
53
-
>The text that appears as a section header and that toggles open and close the text that appears below it. HTML is acceptable.
57
+
>The text that appears as a section header and that toggles open and close the text that appears below it. HTML is acceptable.
58
+
54
59
>#####description
55
60
>The text that appears below the `title`. It is open and closed when the user clicks on its `title`. HTML is acceptable.
56
61
@@ -69,11 +74,10 @@ Optional icons linked to social media/networking accounts.
69
74
>_link
70
75
>The URL that will be followed if a user clicks on the icon. It should take the form of a fully qualified internet address, including any parameters that identify the account. If the `_link` is not provided, the icon will not be displayed. If you don't want any icons to appear, don't provide any `_links`. You can, in fact, omit from `course.json` the complete `_socialLinks` section.
71
76
72
-
##Installation
73
-
74
-
First, be sure to install the [Adapt Command Line Interface](https://github.com/adaptlearning/adapt-cli), then from the command line run:-
75
-
76
-
adapt install adapt-aboutUs
77
+
78
+
##Limitations
79
+
80
+
- Accessibility and RTL support have not been addressed.
0 commit comments