diff --git a/README.md b/README.md index 90100ef..9a60c2b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ - - - + -# Verify certificates # +# Block Verify certificates # -TODO Describe the plugin shortly here. +The block allows to verify all certificates installed in your Moodle using a single form. + +**Note**: This is different to existing [Verify Certificate Block](https://moodle.org/plugins/block_verify_certificate) + +## Build-in supported certificates ## + +* Course certificate ([mod_coursecertificate](https://moodle.org/plugins/mod_coursecertificate)) +* Custom certificate ([mod_customcert](https://moodle.org/plugins/mod_customcert)) -TODO Provide more detailed description here. ## Installing via uploaded ZIP file ## @@ -31,6 +35,36 @@ Alternatively, you can run to complete the installation from the command line. +## Configuration + +Navigate to **Site administration > Blocks > Verify certificates** to configure the block. + + +## Capabilities +Users must have **View a verify certificates block (block/verify_certs:view)** capability to use this block. + +By default, this capability is granted to Authenticated user role. + + +## Extending support for custom certificates + +Any plugin can easily implement a support for any other certificates by adding classes in the `local\block_verify_certs\certificates` namespace. Each certificate must extend the [base class](classes/local/block_verify_certs/certificates/base.php). As an example, block itself provides some certificates; the directory structure is as follows: + + +``` +block_verify_certs +└── classes +    └── local +    └── block_verify_certs +     └── certificates +      ├── mod_coursecertificate.php +      └── mod_customcert.php +``` + +## Warm thanks + +Thanks to **Terri Roshell (TN Fire Training Online)** for funding the development of this plugin. + ## License ## 2023 Dmitrii Metelkin diff --git a/lang/en/block_verify_certs.php b/lang/en/block_verify_certs.php index 56ae7b1..84200d0 100644 --- a/lang/en/block_verify_certs.php +++ b/lang/en/block_verify_certs.php @@ -44,4 +44,4 @@ $string['verifycertificates'] = 'Verify certificates'; $string['verify_certs:addinstance'] = 'Add a verify certificates block'; $string['verify_certs:myaddinstance'] = 'Add a new a verify certificates block to Dashboard'; -$string['verify_certs:view'] = 'View a verify certificates block '; +$string['verify_certs:view'] = 'View a verify certificates block';