diff --git a/.gitignore b/.gitignore index 192a733..00805ad 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,6 @@ __pycache__ site examples/*.html +/build/ +/dist/ +/venv/ diff --git a/examples/pg_report.md b/examples/pg_report.md new file mode 100644 index 0000000..090c757 --- /dev/null +++ b/examples/pg_report.md @@ -0,0 +1,29 @@ +--- +student: Some Student +supervisor: Some Staff Member +role: First Supervisor +code: 7048CEM +--- + +# Objectives [10/10] + + - Objective comments +# Research Methods [30/30] + + - RM Comments + +# Data Collection [20/20] + + - Data collection comments +# Solution [20/20] + + - Comment + + +# Project Management [10/10] + + - Comments on project management + +# Report Structure [10/10] + + - Report structure comments diff --git a/remarkable/templates/pg_proj_rep/report.jinja2 b/remarkable/templates/pg_proj_rep/report.jinja2 new file mode 100644 index 0000000..dc165ad --- /dev/null +++ b/remarkable/templates/pg_proj_rep/report.jinja2 @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + {{header.code}} Final Feedback + + + + + + +
+
+

{{header.code}} Project Report

+

Report Grading and Feedback

+
+ +
+
+
Student Name
+
+
+ {{ header.student }} +
+
+
+
+
{{ header.role }}
+
+
+ {{ header.supervisor }} +
+
+ + + +
+
+

Overall Meeting of Objectives in relation to research question

+
+
+

{{content.Objectives.getMarks()}}

+
+
+
+
+ Criteria +
    +
  • Formulate a research question and derived objectives suitable for the degree and consistent with the time and resource available to conduct the research. +
  • Achievement of project objectives + +
+
+
+
+
+

Comments:

+ {{ content.Objectives }} +
+
+ + +
+
+

Research Methods and Literature Review, with Discussion and Analysis

+
+
+

{{ content.Research_Methods.getMarks() }}

+
+
+
+
+ Criteria +
    +
  • Critically evaluate the context of the research, + synthesising ideas from a referenced review of relevant + source material.
  • +
  • Select and justify choice of approach taken in + research (i.e. research methods) to suit the + requirements of the specific research + question.
  • + +
+
+
+
+
+

Comments:

+ {{ content.Research_Methods }} +
+
+ + + + + +
+
+

Data Collection, Analysis and Discussion

+
+
+

{{content.Data_Collection.getMarks()}}

+
+
+
+
+ Criteria +
    +
  • Devise and perform an investigation, informed by the finding or previous workers in the field. +
  • For practical problem solving projects to include requirements/design/implementation/testing. +
+
+
+
+
+

Comments:

+ {{content.Data_Collection}} +
+
+ + + + +
+
+

Solution, Conclusion and Recommendations

+
+
+

{{content.Solution.getMarks()}}

+
+
+
+
+ Criteria +
    +
  • The degree of ingenuity and originality in the formulation of a solution and conclusions thereof +
  • Summarised critical evaluation of subject area +
  • Recommendations for identifiable problem area, with consideration to short to medium term resolutions' +
  • Recommendations for the long term future +
  • Depth of thought, consideration, with a build up rationale supported by the project approach +
  • Present finding/solution with clarity. +
  • Demonstration of benefit of work undertaken. +
  • For practical problem solving projects to include products (working systems or prototypes) - This may require a software demonstration of the working product. + +
+
+
+
+
+

Comments:

+ {{content.Solution}} +
+
+ + + + +
+
+

Project Management and Critical Evaluation of Performance and Conduct

+
+
+

{{content.Project_Management.getMarks()}}

+
+
+
+
+ Criteria +
    +
  • Critical evaluation of project conduct, appropriateness of methods employed with lessons learnt and effectiveness of the experience +
  • PM and quality assurance of conduct of project +
  • Utilisation of appropriate project management practices including Risk Analysis, work breakdown and gannt charts +
  • Consideration of risks in carrying out the research. + +
+
+
+
+
+

Comments:

+ {{content.Project_Management}} +
+
+ + + + + +
+
+

Report Structure and Cohesiveness

+
+
+

{{ content.Report_Structure.getMarks() }}

+
+
+
+
+ Please comment on: +
    +
  • Flow, professionalism, comprehension, completeness and presentation of report, utilisation and +reference to appropriate diagrams, charts, figures +
+
+
+
+
+

Comments:

+ {{ content.Report_Structure }} +
+
+ + + +
+
+

TOTAL

+
+
+

{{ calcs.marksAwarded }}

+
+ +
+
+ + + + + + + + + + + + + + + +