Skip to content

Commit

Permalink
Deployed 443bf4f with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
djplaner committed Apr 19, 2024
1 parent 31b2033 commit 2d1a3cd
Show file tree
Hide file tree
Showing 9 changed files with 167 additions and 89 deletions.
Binary file added Limitations/images/deleted-page-number.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Limitations/images/multiple-pages-same-title.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Limitations/images/restore-config-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
100 changes: 89 additions & 11 deletions Limitations/limitations/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2921,18 +2921,18 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#canvas-mobile-apps-not-usable" class="md-nav__link">
<a href="#cannot-be-used-via-canvas-mobile-apps-only-via-web-browsers" class="md-nav__link">
<span class="md-ellipsis">
Canvas mobile apps - not usable
Cannot be used via Canvas mobile apps, only via web browsers
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#collections-installed-and-active-live-collections" class="md-nav__link">
<a href="#collections-must-be-installed-and-active-for-live-collections" class="md-nav__link">
<span class="md-ellipsis">
Collections installed and active - live Collections
Collections must be installed and active (for live Collections)
</span>
</a>

Expand All @@ -2945,6 +2945,30 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#problems-if-you-delete-and-re-create-the-collections-configuration-page" class="md-nav__link">
<span class="md-ellipsis">
Problems if you delete and re-create the Collections configuration page
</span>
</a>

<nav class="md-nav" aria-label="Problems if you delete and re-create the Collections configuration page">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#solution-undelete-the-original-collections-configuration-page" class="md-nav__link">
<span class="md-ellipsis">
Solution - undelete the original Collections configuration page
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -2990,18 +3014,18 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#canvas-mobile-apps-not-usable" class="md-nav__link">
<a href="#cannot-be-used-via-canvas-mobile-apps-only-via-web-browsers" class="md-nav__link">
<span class="md-ellipsis">
Canvas mobile apps - not usable
Cannot be used via Canvas mobile apps, only via web browsers
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#collections-installed-and-active-live-collections" class="md-nav__link">
<a href="#collections-must-be-installed-and-active-for-live-collections" class="md-nav__link">
<span class="md-ellipsis">
Collections installed and active - live Collections
Collections must be installed and active (for live Collections)
</span>
</a>

Expand All @@ -3014,6 +3038,30 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#problems-if-you-delete-and-re-create-the-collections-configuration-page" class="md-nav__link">
<span class="md-ellipsis">
Problems if you delete and re-create the Collections configuration page
</span>
</a>

<nav class="md-nav" aria-label="Problems if you delete and re-create the Collections configuration page">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#solution-undelete-the-original-collections-configuration-page" class="md-nav__link">
<span class="md-ellipsis">
Solution - undelete the original Collections configuration page
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -3062,16 +3110,46 @@ <h1 id="limitations">Limitations</h1>
<li>Claytons (static) Collections can be used to navigate without the Collections source code (but has to be configured with the code), but some representations will require additional CSS. <a href="#claytons-collections---no-code-but-some-css-may-be-required">see more</a></li>
</ol>
</div>
<h2 id="canvas-mobile-apps-not-usable">Canvas mobile apps - not usable</h2>
<h2 id="cannot-be-used-via-canvas-mobile-apps-only-via-web-browsers">Cannot be used via Canvas mobile apps, only via web browsers</h2>
<p>Canvas Collections is custom JavaScript/CSS that modifies the Canvas modules <em>web</em> page and helps with navigation to Canvas modules (on the Canvas modules <em>web</em> page). The Canvas mobile apps do not use Canvas <em>web</em> pages and do <a href="https://community.canvaslms.com/t5/Canvas-Mobile-Forum/iOS-app-and-Canvas/m-p/465811/highlight/true#M350">not (at least easily) support custom JavaScript/CSS</a>. </p>
<h2 id="collections-installed-and-active-live-collections">Collections installed and active - live Collections</h2>
<p>Collection provides <a href="../../configure/overview/">configuration</a> and <a href="../../navigate/navigate-options/">navigation</a> functionality.</p>
<h2 id="collections-must-be-installed-and-active-for-live-collections">Collections must be installed and active (for live Collections)</h2>
<p>Collection provides <a href="../../configure/overview/">configuration</a> (teaching staff) and <a href="../../navigate/navigate-options/">navigation</a> (all users) functionality.</p>
<p>To configure Canvas Collections you must be using a Web browser with the Collections JavaScript <a href="../../getting-started/install/is-it-installed/">installed and active</a>. </p>
<p>Collections provides <a href="../../navigate/navigate-options/">two navigation experiences</a>: live Collections and Claytons Collections. Live Collections requires the Collections JavaScript to be installed and active. </p>
<h2 id="claytons-collections-no-code-but-some-css-may-be-required">Claytons Collections - no code, but some CSS may be required</h2>
<p>Navigating with Claytons Collections is essentially viewing a Canvas page with static HTML and CSS. No JavaScript is required. However, Canvas <a href="https://community.canvaslms.com/t5/Canvas-Resource-Documents/Canvas-HTML-Editor-Allowlist/ta-p/387066">limits what HTML and CSS</a> can be used on Canvas pages.</p>
<p>Some <a href="../../reference/conceptual-model/representations/overview/">representations</a> fit within those limits (e.g. the <a href="../../reference/conceptual-model/representations/horizontal-cards/"><em>HorizontalCards</em> representation</a>), but others do not (e.g. the <a href="../../reference/conceptual-model/representations/griffith-cards/"><em>GriffithCards</em> representation</a>). The latter will not display correctly without this HTML/CSS.</p>
<p>Adding the required HTML/CSS is difficult if not impossible for mobile app users (<a href="#canvas-mobile-apps---essentially-not-usable">see above</a>). For web browsers, the relevant HTML/CSS can be installed either by the Canvas administrator, or by the teacher/designer where a tool like CIDI Labs Design Plus is available.</p>
<h2 id="problems-if-you-delete-and-re-create-the-collections-configuration-page">Problems if you delete and re-create the Collections configuration page</h2>
<p>Canvas Collections stores all its configuration information in a single Canvas page in the host course. That page must be called "Canvas Collections Configuration" and have the url <em>https://<your_canvas_instance>/courses/<course_id>/pages/canvas-collections-configuration</em>. If Collections cannot access this page, it will not work.</p>
<p>In September, 2013 Instructure introduced changes to <a href="https://community.canvaslms.com/t5/Canvas-Releases/Canvas-Release-Notes-2023-09-16/ta-p/577167#toc-hId-1051913398">how page titles and URLs operate</a>. Changes which mean the page title <a href="https://community.canvaslms.com/t5/Canvas-Question-Forum/Page-URL-doesn-t-match-page-title/m-p/590189">may not match the page URL</a>. For example, you may see a page titled "Canvas Collections Configuration" in your course, but if you examine the URL it will look something like <em>https://<your_canvas_instance>/courses/<course_id>/pages/canvas-collections-configuration<strong>-5</strong></em>.</p>
<div class="admonition note">
<p class="admonition-title">Canvas adds numbers to URLs to distinguish repeated page titles"</p>
<p>The URL above ended in <strong>-5</strong>. Representing Canvas' practice of adding a number to a URL when multiple pages have the same name.</p>
</div>
<figure>
<figcaption>Two pages with the same name. The most recent page's URL ends with <strong>canvas-collections-configuration-2</strong> as the second page created with that title.</figcaption>
<p><img alt="" src="../images/multiple-pages-same-title.png" /></p>
</figure>
<div class="admonition note">
<p class="admonition-title">Deleting results in <strong>-5</strong> outcomes</p>
<p>Due to the changes in 2013, if you delete a Canvas page any subsequent page created with the same page title will have a URL ending in a number.</p>
</div>
<figure>
<figcaption>Deleting the first two pages named "Canvas Collections Configuration" and creating a new page with the same title results in the URL ending in <strong>-3</strong></figcaption>
<p><img alt="" src="../images/deleted-page-number.png" /></p>
</figure>
<div class="admonition warning">
<p class="admonition-title">Collections will not work if the configuration page URL does not match the expected URL</p>
<p>A situation like the above will cause Collections to fail.</p>
</div>
<h3 id="solution-undelete-the-original-collections-configuration-page">Solution - undelete the original Collections configuration page</h3>
<p>The solution to this problem is to use Canvas' <a href="https://teacherscollege.screenstepslive.com/a/1471900-recover-deleted-course-content-in-canvas">recover deleted course content functionality</a> to undelete the original Collections configuration page. This will restore the page with the correct URL and enable you to use Collection's configuration functionality.</p>
<p>As shown in the following figure, there may be multiple <em>Canvas Collections Configuration</em> pages to choose from. Choose the one created first.</p>
<figure>
<figcaption>Multiple Collections configuration pages to be restored</figcaption>
<p><img alt="" src="../images/restore-config-page.png" /></p>
</figure>



Expand Down
4 changes: 2 additions & 2 deletions configure/configure-collections/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1032,7 +1032,7 @@
<li class="md-nav__item">
<a href="#2-turn-on-editing" class="md-nav__link">
<span class="md-ellipsis">
2. Turn on editing
2. Turn on editing
</span>
</a>

Expand Down Expand Up @@ -3045,7 +3045,7 @@
<li class="md-nav__item">
<a href="#2-turn-on-editing" class="md-nav__link">
<span class="md-ellipsis">
2. Turn on editing
2. Turn on editing
</span>
</a>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2924,7 +2924,7 @@


<h1 id="visibility-collections-configuration">Visibility - Collections Configuration</h1>
<p><img alt="🚧" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.0.3/assets/svg/1f6a7.svg" title=":construction:" /> </p>
<p><img alt="🚧" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@14.1.2/assets/svg/1f6a7.svg" title=":construction:" /> </p>



Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit 2d1a3cd

Please sign in to comment.