Miqra-Engineering/moodle_local_treestudyplan
2
0
Fork 0
Code Issues 13 Pull Requests Packages Projects Releases 4 Wiki Activity

Minor documentation changes

Browse Source
This commit is contained in:
PMKuipers 2023-08-15 16:26:03 +02:00
parent fcfcc6570b
commit 0a6c0d8dd8
9 changed files with 48 additions and 11968 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@ -1,58 +1,15 @@
# moodle-local_treestudyplan # moodle-local_treestudyplan
## Installing
## Adding links to the primary navigation menu Install the plugin by adding the zip file from the
The studyplan plugin will automatically add links to the flat navigation bat used in Moodle 3.11 and below
However, Moodle 4.0-4.2 use a new "primary navigation" bar, and does not yet support customizing the primary navigation bar (it is a planned feature though)
**Use the following workaround:**
You can add custom primary menu items in **Site administration** -> **Appearance** -> **Theme settings**
That page contains an item called "Custom menu items"
Add the following into that area to custimize it
// [your name for my studyplan]|/local/treestudyplan/myreport.php
// [your name for studyplan viewing]|/local/treestudyplan/view-plan.php
// [your name for studyplan managing]|/local/treestudyplan/edit-plan.php
// For example:
```
Mijn studieplan|/local/treestudyplan/myreport.php||nl
Studieplannen|/local/treestudyplan/view-plan.php||nl
Studieplannen beheren|/local/treestudyplan/edit-plan.php||nl
My study plan|/local/treestudyplan/myreport.php||en
Study plans|/local/treestudyplan/view-plan.php||en
Manage Study plans|/local/treestudyplan/edit-plan.php||en
```
## Dev Notepad
### Size matching and grid view
Link to jsfiddle for size matching with different scroll area (frozen line headings): https://jsfiddle.net/pmkuipers/sfweghr1/4/
Use proper grid styling for column resizing (see same fiddle)
### Scroll bar syling ## Documentation / User manual
example style with cross-browser support After installing the plugin, the user manual can be found under **Site administration** -> **Courses** -> **Studyplans** -> **Studyplan plugin documentation**
``` Alternatively, you can unpack this ZIP file and open the **doc/index.html** file.
:root{ (Note that viewing the html files directly will not five the optimal experience, since fontawesome tags and bootstrap items will not be properly rendered)
--primary: #006DDD;
## Development
} To build a release zip, you can use the script **./build.sh**. This script calls grunt to build the javascript minified files where needed and creates a relase zip file with the current plugin version (as defined in *version.php*) in the directory **/build**
div.scroll {
height: 50em;
overflow-y: scroll;
scrollbar-color: var(--primary) color-mix(in srgb, var(--primary) 20%, white);
scrollbar-width: thin;
}
div.scroll::-webkit-scrollbar {
width: 8px;
}
/* Track */
div.scroll::-webkit-scrollbar-track {
background: color-mix(in srgb, var(--primary) 20%, white);
}
/* Handle */
div.scroll::-webkit-scrollbar-thumb {
background:var(--primary);
}
```

11912
amd/build/vue.min.js vendored
View File

File diff suppressed because one or more lines are too long

1
amd/build/vue.min.js.map Normal file
View File

File diff suppressed because one or more lines are too long

7
doc/advanced.htm
View File

@ -1,3 +1,6 @@
<html>
<head></head>
<body>
<div> <div>
<h1> Studyplan user manual</h1> <h1> Studyplan user manual</h1>
<ul class="nav nav-tabs"> <ul class="nav nav-tabs">
@ -141,4 +144,6 @@
</div> </div>
</body>
</html>

7
doc/configuration.htm
View File

@ -1,3 +1,6 @@
<html>
<head></head>
<body>
<div> <div>
<h1> Studyplan user manual</h1> <h1> Studyplan user manual</h1>
<ul class="nav nav-tabs"> <ul class="nav nav-tabs">
@ -120,4 +123,6 @@
}</pre> }</pre>
</div> </div>
</body>
</html>

7
doc/create-studyplan.htm
View File

@ -1,3 +1,6 @@
<html>
<head></head>
<body>
<div> <div>
<h1> Studyplan user manual</h1> <h1> Studyplan user manual</h1>
<ul class="nav nav-tabs"> <ul class="nav nav-tabs">
@ -198,4 +201,6 @@
</div> </div>
</div> </div>
</body>
</html>

7
doc/index.htm
View File

@ -1,3 +1,6 @@
<html>
<head></head>
<body>
<div> <div>
<h1> Studyplan user manual</h1> <h1> Studyplan user manual</h1>
<ul class="nav nav-tabs"> <ul class="nav nav-tabs">
@ -41,4 +44,6 @@ Manage Study plans|/local/treestudyplan/edit-plan.php||en
<p><img src="img/Siteconfig.png" class="border border-primary rounded-lg ml-3"></p> <p><img src="img/Siteconfig.png" class="border border-primary rounded-lg ml-3"></p>
<p>The page <a href="configuration.htm"><b>Configuration</b></a> gives more details about the configuration options</p> <p>The page <a href="configuration.htm"><b>Configuration</b></a> gives more details about the configuration options</p>
</div> </div>
</body>
</html>

7
doc/teacherview-studyplan.htm
View File

@ -1,3 +1,6 @@
<html>
<head></head>
<body>
<div> <div>
<h1> Studyplan user manual</h1> <h1> Studyplan user manual</h1>
<ul class="nav nav-tabs"> <ul class="nav nav-tabs">
@ -79,4 +82,6 @@
<p>By selecting <button type="button" class="list-group-item list-group-item-primary list-group-item-action">Teacher view</button>, the teacher can <p>By selecting <button type="button" class="list-group-item list-group-item-primary list-group-item-action">Teacher view</button>, the teacher can
return to the teacher view</p> return to the teacher view</p>
</div> </div>
</body>
</html>

7
doc/view-studyplan.htm
View File

@ -1,3 +1,6 @@
<html>
<head></head>
<body>
<div> <div>
<h1> Studyplan user manual</h1> <h1> Studyplan user manual</h1>
<ul class="nav nav-tabs"> <ul class="nav nav-tabs">
@ -113,4 +116,6 @@
the invitee can see the student's study plan, grades and provided feedback. the invitee can see the student's study plan, grades and provided feedback.
</p> </p>
<p>Upon deleting the invitation, the unique link is immediately deactivated and all access the invitee had to view the student's studyplan is revoked.</p> <p>Upon deleting the invitation, the unique link is immediately deactivated and all access the invitee had to view the student's studyplan is revoked.</p>
</div> </div>
</body>
</html>