Merge pull request #231 from Wachizungu/link-forgotten-chapters

chg: Link/add forgotten chapters MISP objects and keyboard shortcuts

SUMMARY.md

@@ -19,6 +19,7 @@
 * [Create an Event Based on a Report](create-event-report/README.md)
 * [Taxonomies](taxonomy/README.md)
 * [Galaxies](galaxy/README.md)
+* [MISP Objects](misp-objects/README.md)
 * [Sightings](sightings/README.md)
 * [Warning lists](warninglists/README.md)
 * [Notice lists](noticelists/README.md)
@@ -27,6 +28,7 @@
 * [External Connectors](connectors/README.md)
 * [Modules](modules/README.md)
 * [ZeroMQ - MISP publish-subscribe](misp-zmq/README.md)
+* [Keyboard shortcuts](keyboard-shortcuts/README.md)
 * [Translations - i18n & l10n](translation/README.md)
 * [FAQ](faq/README.md)
 * [Dev FAQ](dev-faq/README.md)

keyboard-shortcuts/README.md

@@ -0,0 +1,23 @@
+<!-- toc -->
+
+# Keyboard shortcuts in MISP
+
+MISP has keyboard shortcuts managed using JSON files.
+To see the list of shortcuts for a given page, press the small black triangle at the bottom right of the page.
+**Demo:**
+![Demo video of showing the keyboard shortcuts in the MISP GUI](./figures/demo.gif)
+
+**Q: Is it possible to customize the shortcuts in the GUI once they are there?**
+**A:** Not at the moment.
+
+**Q: How do I add keyboard shortcuts to my MISP instance?**
+**A:**
+1. Add a JSON file in `app/webroot/shortcuts` named after the page from which it will be included (for example `event_view.json`).
+2. Set your shortcuts using this format: 
+![JSON configuration example](./figures/json-config-example.png)
+(`action` field is JS code) 
+
+2. Include the keyboard shortcut config in the `.ctp` file you wish it to be used in using an `input type="hidden"` tag like this: 
+![Image of code to add to view page to enable keyboard shortcuts](./figures/add-shortcuts-to-view-page.png)
+
+3. Test your shortcuts.

misp-objects/README.md

@@ -1,10 +1,10 @@
 <!-- toc -->
 
-## MISP-Objects
+# MISP Objects
 
 [MISP objects](https://github.com/MISP/misp-objects) to be used in MISP (2.4.80) system and can be used by other information sharing tool. MISP objects are in addition to MISP attributes to allow advanced combinations and concatenation of attributes. The creation of these objects and their associated attributes are based on real cyber security use-cases and existing practices in information sharing.
 
-### Using object
+## Using objects
 
 Objects can be added by using the side menu:  
 ![This menu allows you to add objects.](figures/add_object.png)
@@ -25,7 +25,7 @@ For some objects, there might be attributes that required to be set. For instanc
 After pressing "Submit, you are given the possibility to review your object before saving it.  
 ![object preview](figures/object_preview.png)
 
-### Creating object
+## Creating object
 
 An object is designed using a JSON file which should respect a format described in [this document](https://github.com/MISP/misp-objects/blob/master/schema_objects.json).
 
@@ -43,4 +43,4 @@ There are also others options that can be added to define an attribute more prec
 - multiple, if set to true, allow the user to add multiple instances of this attribute.
 
 Not all attributes are mandatory, but some can be required. If so, they need to be listed in a list called "required". The object will only be valid if the listed attributes are set.
-The same way, there are sometimes when only one attribute in a set is needed. This set can be put in a list called "requiredOneOf". If at least oen of the attributes in this list is set, the object will be valid.
+The same way, there are sometimes when only one attribute in a set is needed. This set can be put in a list called "requiredOneOf". If at least one of the attributes in this list is set, the object will be valid.

shortcuts/README.md

@@ -1,23 +0,0 @@
-<!-- toc -->
-
-## Keyboard shortcuts in MISP
-
-Since v2.4.88, MISP has keyboard shortcuts managed using JSON files.
-To see the list of shortcuts for a given page, press the small black triangle at the bottom of the page.
-**Demo:**
-![peek 2018-02-05 16-31](https://user-images.githubusercontent.com/14599855/35829840-2faaff36-0a92-11e8-8f7c-da995dc01e8c.gif)
-
-**Q: Is it possible to customize the shortcuts in the GUI once they are there?**
-**A:** Not at the moment.
-
-**Q: How do I add keyboard shortcuts to my MISP instance?**
-**A:**
-1. Add a JSON file in `app/webroots/shortcuts` named after the page from which it will be included (for exemple `event_view.json`).
-2. Set your shortcuts using this format: 
-![image](https://user-images.githubusercontent.com/14599855/35830021-c80426f4-0a92-11e8-986f-49ded4414010.png)
-(`action` field is JS code) 
-
-2. Include the keyboard shortcut config in the `.ctp` file you wish it to be used in using an `input type="hidden"` tag like this: 
-![image](https://user-images.githubusercontent.com/14599855/35830084-02f880ac-0a93-11e8-86fa-9cb4f0f95480.png)
-
-3. Test your shortcuts.

using-the-system/README.md

@@ -57,7 +57,7 @@ Keep in mind that the system searches for regular expressions in the value field
 
 ### Add Object
 
-Please have a look at the [MISP-objects chapter](../misp-object/README.md)
+Please have a look at the [MISP objects chapter](../misp-objects/README.md)
 
 
 ### Create and manage Sharing Groups