| | 1 | = Lucide Plugin Guide = |
| | 2 | == Quick Overview == |
| | 3 | Expect this part to get fleshed out in due time. |
| | 4 | |
| | 5 | 1. Determine a need for a plugin (what format is not yet supported or is supported but which could be improved?). |
| | 6 | 2. Find a back end library to support the format (e.g., Poppler for PDF, !DjVulibre for !DjVu, libjpeg for JPEG). |
| | 7 | 3. Review the [/wiki/Lucide-Plugin-API Plugin API page] to determine how best to implement the plugin using the selected backend library. |
| | 8 | 4. Create a help document (IPF) specific to the new plugin. |
| | 9 | 5. Package the plugin as an RPM. |
| | 10 | 6. Submit it for review or distribute it yourself from your own repo. |
| | 11 | |
| | 12 | == Plugin-specific Help == |
| | 13 | Lucide honors the LUCIDEHELP environment variable in CONFIG.SYS. Plugin-specific help files should be appended to this list, e.g.: |
| | 14 | |
| | 15 | {{{ |
| | 16 | SET LUCIDEHELP=lucide_en.hlp+amazing-new-plugin_en.hlp |
| | 17 | }}} |
| | 18 | |
| | 19 | The plugin-specific help document will be loaded as an appendix to the main help guide. |
| | 20 | |
| | 21 | N.B.: Be careful to use unique resource IDs in the IPF to avoid confusion with any others, including Lucide's own help file. |
