fixes improperly formatted external tool documentation
also modified the documentation for external tool configurations to clarify how "environment" settings work Test plan: - verify that underscores are displaying instead of italicizing content Change-Id: Ie62d11018becdc9a5281f3d25907827814d3fb7d Reviewed-on: https://gerrit.instructure.com/25191 Reviewed-by: Brad Humphrey <brad@instructure.com> Product-Review: Brad Humphrey <brad@instructure.com> QA-Review: Brad Humphrey <brad@instructure.com> Tested-by: Jenkins <jenkins@instructure.com>
This commit is contained in:
parent
af42310ed2
commit
6fe9daca43
|
@ -11,7 +11,7 @@ they'll see the tool loaded in an iframe on the page. The tool can then
|
|||
send grading information back to Canvas.
|
||||
|
||||
Tools can know that they have been launched in a graded context because
|
||||
an additional parameter is sent across, <code>lis_outcome_service_url</code>,
|
||||
an additional parameter is sent across, `lis_outcome_service_url`,
|
||||
as specified in the LTI 1.1 specification. Grades are passed back to Canvas
|
||||
from the tool's servers using the
|
||||
<a href="http://www.imsglobal.org/lti/v1p1pd/ltiIMGv1p1pd.html#_Toc309649691">outcomes component of LTI 1.1</a>.
|
||||
|
|
|
@ -18,7 +18,7 @@ of the configured tools in a dropdown.
|
|||
|
||||
When tools are loaded as rich editor buttons, Canvas sends an additional
|
||||
parameter to notify the tool of the directive,
|
||||
<code>ext_content_return_types=embed_content</code>. When a tool receives this directive,
|
||||
`ext_content_return_types=embed_content`. When a tool receives this directive,
|
||||
it means Canvas is expecting the tool to redirect the user to the LTI
|
||||
success URL with some additional parameters. These additional parameters
|
||||
tell Canvas what type of content to embed, as listed below. Remember to
|
||||
|
@ -54,7 +54,7 @@ that all URLs you return be over SSL (https instead of http).
|
|||
</table>
|
||||
|
||||
#### examples:
|
||||
If the <code>launch_presentation_return_url</code> were
|
||||
If the `launch_presentation_return_ur`l</code> were
|
||||
<code>http://www.example.com/done</code>, possible return URLs could include:
|
||||
|
||||
- http://www.example.com/done?return_type=image_url&url=https%3A%2F%2Fothersite.com%2Fimage.gif&alt=good+picture&width=30&height=50
|
||||
|
@ -86,7 +86,7 @@ If the <code>launch_presentation_return_url</code> were
|
|||
</table>
|
||||
|
||||
#### examples:
|
||||
If the <code>launch_presentation_return_url</code> were
|
||||
If the `launch_presentation_return_url`</code> were
|
||||
<code>http://www.example.com/done</code>, possible return URLs could include:
|
||||
|
||||
- http://www.example.com/done?return_type=iframe&url=https%3A%2F%2Fothersite.com%2Fiframe&width=30&height=50
|
||||
|
@ -118,7 +118,7 @@ If the <code>launch_presentation_return_url</code> were
|
|||
</table>
|
||||
|
||||
#### examples:
|
||||
If the <code>launch_presentation_return_url</code> were
|
||||
If the `launch_presentation_return_url` were
|
||||
<code>http://www.example.com/done</code>, possible return URLs could include:
|
||||
|
||||
- http://www.example.com/done?return_type=url&url=https%3A%2F%2Fothersite.com%2Flink
|
||||
|
@ -147,7 +147,7 @@ If the <code>launch_presentation_return_url</code> were
|
|||
</table>
|
||||
|
||||
#### examples:
|
||||
If the <code>launch_presentation_return_url</code> were
|
||||
If the `launch_presentation_return_url` were
|
||||
<code>http://www.example.com/done</code>, possible return URLs could include:
|
||||
|
||||
- http://www.example.com/done?return_type=lti_launch_url&url=https%3A%2F%2Fothersite.com%2Flti_link
|
||||
|
@ -176,7 +176,7 @@ For other types of rich content (such as a video tag, a large block of text, etc
|
|||
</table>
|
||||
|
||||
#### examples:
|
||||
If the <code>launch_presentation_return_url</code> were
|
||||
If the `launch_presentation_return_url` were
|
||||
<code>http://www.example.com/done</code>, possible return URLs could include:
|
||||
|
||||
- http://www.example.com/done?return_type=oembed&endpoint=https%3A%2F%2Fothersite.com%2Foembed&url=https%3A%2F%2Fothersite.com%2Fresources%2Fimage1
|
||||
|
|
|
@ -17,17 +17,17 @@ LTI content extension to communicate what types of content are
|
|||
accepted. This extension adds the following parameters to the LTI
|
||||
launch event:
|
||||
|
||||
- <b>ext_content_intended_use:</b> This describes what the content will be used
|
||||
- <b>ext\_content\_intended\_use:</b> This describes what the content will be used
|
||||
for once it is returned to Canvas. For a homework submission tools the
|
||||
value will be "homework".
|
||||
|
||||
- <b>ext_content_return_types:</b> A comma separated list of the possible return
|
||||
- <b>ext\_content\_return\_types:</b> A comma separated list of the possible return
|
||||
types. The possible values for homework submissions are "file" and "url".
|
||||
|
||||
- <b>ext_content_return_url:</b> The url that the external tool should redirect
|
||||
- <b>ext\_content\_return\_url:</b> The url that the external tool should redirect
|
||||
the user to with the selected content.
|
||||
|
||||
- <b>ext_content_file_extensions</b> (optional): A comma separated list of the file
|
||||
- <b>ext\_content\_file\_extensions</b> (optional): A comma separated list of the file
|
||||
extensions that are allowed as valid submissions for this assignment.
|
||||
|
||||
When a tool receives these launch parameters, it means that Canvas is
|
||||
|
@ -62,7 +62,7 @@ that all URLs you return be over SSL (https instead of http).
|
|||
</table>
|
||||
|
||||
#### examples:
|
||||
If the <code>launch_presentation_return_url</code> were
|
||||
If the `launch_presentation_return_url` were
|
||||
<code>http://www.example.com/done</code>, possible return URLs could include:
|
||||
|
||||
- http://www.example.com/done?return_type=file&url=https%3A%2F%2Fothersite.com%2Ffile.pdf&text=good+picture.pdf
|
||||
|
@ -82,7 +82,7 @@ If the <code>launch_presentation_return_url</code> were
|
|||
</table>
|
||||
|
||||
#### examples:
|
||||
If the <code>launch_presentation_return_url</code> were
|
||||
If the `launch_presentation_return_url` were
|
||||
<code>http://www.example.com/done</code>, possible return URLs could include:
|
||||
|
||||
- http://www.example.com/done?return_type=url&url=https%3A%2F%2Fothersite.com%2Flink
|
||||
|
|
|
@ -19,7 +19,7 @@ the these type of tools as domain-matching tool and only return URLs
|
|||
whose domain matches the tool's specified domain.
|
||||
|
||||
When tools are loaded as link selectors, Canvas sends an additional
|
||||
parameter to notify the tool of the directive, "ext_content_return_types=select_link".
|
||||
parameter to notify the tool of the directive, `ext_content_return_types=select_link`.
|
||||
When a tool receives this directive, it means Canvas is expecting the
|
||||
tool to redirect the user to the LTI success URL with some specific
|
||||
additional parameters. These additional parameters tell Canvas what
|
||||
|
@ -49,7 +49,7 @@ values such as url.
|
|||
</table>
|
||||
|
||||
#### examples:
|
||||
If the <code>launch_presentation_return_url</code> were
|
||||
If the `launch_presentation_return_url` were
|
||||
<code>http://www.example.com/done</code>, possible return URLs could include:
|
||||
|
||||
- http://www.example.com/done?return_type=lti_launch_url&url=https%3A%2F%2Fothersite.com%2Flti_link
|
||||
|
|
|
@ -396,11 +396,15 @@ matching, and to only return URLs matching that domain.
|
|||
## Test Environment Setting Examples
|
||||
|
||||
External tools can support different LTI environments for different canvas environments.
|
||||
If the URL is set it will replace the launch_url in the test and beta canvas environments.
|
||||
If the domain is set it will replace the domain setting and the domain on all configured
|
||||
links with the test domain. It will only replace configured settings on tools. For example,
|
||||
if the launch_url parameter is not set in the main configuration, the environment's
|
||||
launch_url will have no affect when the tool is copied to another canvas environment.
|
||||
|
||||
* __domain__: All url domains in this tool's configuration will be replaced with this domain
|
||||
* __launch_url__: the blti:launch\_url property that should be used for all canvas test environments.
|
||||
This property takes precedent over domain changes if both properties are set.
|
||||
|
||||
Additionally, the domain and launch\_urls can be set for for each canvas environment
|
||||
by specifying the environment as part of the property name (ie, test\_launch\_url,
|
||||
beta\_domain, etc). When used in this manner, specific environment properties take
|
||||
precedent over the default values.
|
||||
|
||||
### Test Environment Example
|
||||
|
||||
|
|
Loading…
Reference in New Issue