From 49a43c854f130bee186e53961844a2b624f6b425 Mon Sep 17 00:00:00 2001 From: Dan Goldsmith Date: Wed, 8 Jul 2020 14:48:57 +0100 Subject: [PATCH] Testing Embedding docs as a Iframe --- docs/examples/CourseworkBrief.html | 330 +++++++++++++++++++++++++++++ docs/examples/testing.md | 9 + mkdocs.yml | 1 + 3 files changed, 340 insertions(+) create mode 100644 docs/examples/CourseworkBrief.html create mode 100644 docs/examples/testing.md diff --git a/docs/examples/CourseworkBrief.html b/docs/examples/CourseworkBrief.html new file mode 100644 index 0000000..c652da4 --- /dev/null +++ b/docs/examples/CourseworkBrief.html @@ -0,0 +1,330 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Coursework Template + + + + +
+
+ +
+ This document is for Coventry University students for + their own use in completing their assessed work for + this module and should not be passed to third parties + or posted on any website. Any infringements of this + rule should be reported to + facultyregistry.eec@coventry.ac.uk. +
+
+
+ + +
+ +
+ + +
+ Cov Uni Logo +
+
+

Faculty of engineering, Environment and Computing

+
+
+ + +
+
+

Module: NCC-1701 Markdown Marking

+
Assignment Brief
+
+
+ + +
+
+
+
Module Title:
+ Markdown Marking +
+
+
Group / Indivudual
+ + Individual + +
+
+
Cohort
+ Sept +
+
+
Module Code
+ NCC-1701 +
+
+ +
+
+
Coursework Title
+ An Example Coursework Brief +
+
+
Handout Date
+ 1st Week +
+
+ +
+
+
Lecturer
+ Dan Goldsmith +
+
+
Due Date and Time
+ last Week +
+
+ +
+
+
Estimated Time (hrs)
+ 20 Hours +
+
+
Coursework Type
+ Report +
+
+
% of Module Mark
+ 50% +
+
+ + +
+ +
+
Submission Arrangements
+

Via: Moodle

+

Marks release expected: 20-May

+

Feedback Method: Feedback Via Moodle, or whatever abominiation Aula comes up with

+
+
+
+ + +
+ +
+

Module Learning Outcomes Assessed

+
    +
  1. Writing documents in something other than word
    2. +
  2. Responsive, Mobile First output
    3. +
  3. Including Code and Maths
    4. +
+
+
+ +
+ +
+

Task and Mark Distribution

+

This is an example of how we can write coursework, using consistant templates +without entering the horrors of nested tables in Word.

+

Weirdly, HTML turns out to be pretty good at this sort of stuff. I +mean its not like we have been using it for format layout for the last +20 years.

+

Now I know you like your word (or Excel) based marking sheets, but +they are a pain to use:

+
    +
  • Simple things like using tables, are impossible to do in a sane way + with the word nested table approach.
    • +
  • Depending on where we copy and paste from, the output formatting + can get Borked.
    • +
  • Using Excel, means we have that one tiny line to enter feedback + in. Heaven help you if you want line breaks, or to edit something + halfway through.
    • +
+

Equally, HTML means that the forms are Responsive, Mobile First, and Web Scale....

+

Sub Section

+

We support a decent amount of formatting.

+

The AULA Standard.

+
    +
  • [x] Bold Text
    • +
  • [x] itallic italic
    • +
  • [ ] Underline, isn't by default.
    • +
  • [X] HyperLinks
    • +
  • [X] In line codeExamples()
    • +
+

Moving Beyond that...

+

Now stand back, for your own safety.......

+
    +
  • Bullet points
    • +
  • That are not Emojis
      +
    • And Can be Nested
      • +
    +
    • +
+

Enuerations

+
    +
  1. Enumerated List Item
    2. +
  2. Here is another one
    3. +
  3. And yet another one
    4. +
+
+

Block Quotes:

+

A Markdown-formatted document should be publishable +as-is, as plain text, without looking like it’s been marked up with +tags or formatting instructions.

+
+

Tables

+ + + + + + + + + + + + + + + + + + + + + + + +
GradeFail (<35%)Near Miss (<40%)Pass (<50%)
ReportX
RenderingTable DataMore DataAnd More Data
+

Source code formatting in many languages

+
def helloWorld(name):
+    print ("hello {0}".format(name))
+
+if __name__ == "__main__":
+    helloWorld("Dan")
+
+ + +

Maths !!!

+

Euler's formula is remarkable: +

+

And other inline maths $y = mx+c$

+

Or More Maths

+

+ +

+

Writing in Markdown

+

Ok Markdown may not be to everyones taste, but if you cant write a +text file, you really should question some of your life decisions.

+

Also the markdown may not be your markdown. As far as I can make out +its John Grubers +original markdown spec. But there are pugins

+
+
+ + +
+ +
+

Notes:

+
    +
  1. You are expected to use the Coventry University Harvard Referencing Style. For support and + advice on this students can contact Centre + for Academic Writing (CAW).
    2. +
  2. Please notify your registry course support team and module leader for disability support.
    3. +
  3. Any student requiring an extension or deferral should follow the university process as outlined + here. +
    4. +
  4. The University cannot take responsibility for any coursework lost or corrupted on disks, laptops + or personal computer. Students should therefore regularly back-up any work and are advised to + save it on the University system.
    5. +
  5. If there are technical or performance issues that prevent students submitting coursework through + the online coursework submission system on the day of a coursework deadline, an appropriate + extension to the coursework submission deadline will be agreed. This extension will normally be + 24 hours or the next working day if the deadline falls on a Friday or over the weekend period. + This will be communicated via your Module Leader.
    6. +
  6. Collusion between students (where sections of your work are similar to the work submitted + by + other students in this or previous module cohorts) is taken extremely seriously and will be + reported to the academic conduct panel. This applies to both courseworks and exam answers.
    7. +
  7. A marked difference between your writing style, knowledge and skill level demonstrated in class + discussion, any test conditions and that demonstrated in a coursework assignment may result in + you having to undertake a Viva Voce in order to prove the coursework assignment is entirely your + own work.
    8. +
  8. If you make use of the services of a proof reader in your work you must keep your + original + version and make it available as a demonstration of your written efforts.
    9. +
  9. You must not submit work for assessment that you have already submitted (partially or in full), + either for your current course or for another qualification of this university, unless this is + specifically provided for in your assignment brief or specific course or module information. + Where earlier work by you is citable, ie. it has already been published/submitted, you must + reference it clearly. Identical pieces of work submitted concurrently will also be considered to be self-plagiarism.
    10. +
+ +
+
+ +
+ + + + + + + + + + \ No newline at end of file diff --git a/docs/examples/testing.md b/docs/examples/testing.md new file mode 100644 index 0000000..efdc557 --- /dev/null +++ b/docs/examples/testing.md @@ -0,0 +1,9 @@ +# Testing Example Page + +## Embed Tag + + + +## Iframe +Interesting we need to link back a directory + diff --git a/mkdocs.yml b/mkdocs.yml index c8adde0..e721cdc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,6 +22,7 @@ nav: - User Guide: - Installation: userguide/install.md - Getting Started: userguide/tutorial.md + - Examples: examples/testing.md - About: - Why: about/why.md - FAQ: about/FAQ.md