Skip to content

Commit

Permalink
resolved duplicate section names, fixed broken references
Browse files Browse the repository at this point in the history
  • Loading branch information
ofloveandhate committed Jul 24, 2024
1 parent 654e869 commit eff7da0
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 17 deletions.
22 changes: 15 additions & 7 deletions docs/making_links_to_existing_content.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
🔗 Making links to existing content
===================================

* You can use either markdown style links, or html style links.
* Specify the type of content to which you are linking by preceding the name of the content with that type.
*

Notes for links to all content types
----------------------------------------

* You can use either markdown style links, or html style links. Below, I'll give examples using both syntaxes.
* Specify the type of content to which you are linking by preceding the name of the content with that type.

* For example, `assignment:Test Assignment` will make a link to the assignment with name `Test Assignment`.


Link to an assignment
-----------------------
Expand All @@ -14,7 +20,8 @@ To link to an existing Canvas assignment, use a link of the form
.. code-block::
<a href="assignment:Test Assignment">link to Test Assignment</a>
[Test Assignment](assignment:Test Assignment)
[link to Test Assignment](assignment:Test Assignment)
The name must match exactly, including case. This is the name on Canvas, not the name of the containerized content on your local computer. That is, the thing after `assignment:` is the `name` field from `meta.json`.

Expand All @@ -26,6 +33,7 @@ To link to an existing Canvas page, use a link of the form
.. code-block::
<a href="page:Test Page">Link to page titled Test Page</a>
[Link to page titled Test Page](page:Test Page)
The name must match exactly, including case. This is the name on Canvas, not the name of the containerized content on your local computer. That is, the thing after `page:` is the `name` field from `meta.json`.
Expand All @@ -38,15 +46,15 @@ To link to an existing Canvas file, use a link of the form
.. code-block::
<a href="file:DavidenkoDiffEqn.pdf">Link to file called DavidenkoDiffEqn.pdf</a>
[Link to file called DavidenkoDiffEqn.pdf](file:DavidenkoDiffEqn.pdf)
The name must match exactly, including case. This is the name of the file on Canvas. There is currently no way to refer to multiple files of the same name in different folders on Canvas. If you want this, make an issue, or implement it yourself and make a PR.


.. _Links_Notes:

Notes
------
Notes about making links
--------------------------

What if the content doesn't (yet) exist?
******************************************
Expand Down
16 changes: 8 additions & 8 deletions docs/on_meta_dot_json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The `meta.json` file should be present in every containerized content folder.
Valid properties
-----------------

Assignments
*****************
meta.json for Assignments
****************************

In the `meta.json` file for an assignment, the submission type is encoded by a line that looks like the following.

Expand All @@ -24,16 +24,16 @@ These are four of the five upload types available with Canvas. The other is an a
"allowed_extensions": ["pdf","docx"]


Pages
******
meta.json for Pages
***********************


Links
*******
meta.json for Links
************************


Files
*******
meta.json for Files
************************



Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/publication_process_document.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#. :doc:`The style is applied <styling_content>`.
#. :doc:`The style is applied <../tutorials/styling_content>`.

#. The markdown header and footer from the used style are assembled around your `source.md`.
#. The html header and footer from the used style are assembled around that.

#. :doc:`Replacements are done <text_replacements>`.
#. :doc:`Replacements are done <../tutorials/text_replacements>`.
#. :doc:`Emoji shortcodes are emojified <../emoji>`
#. The markdown is translated to HTML.
#. :doc:`Links to existing content are implemented <../making_links_to_existing_content>`, further modifying the HTML.
Expand Down

0 comments on commit eff7da0

Please sign in to comment.