View Issue Details

WikiRelated ChangesetsJump to Notes
IDProjectCategoryView StatusDate SubmittedLast Update
0021657mantisbtdocumentationpublic2016-09-01 03:242023-10-31 16:32
Reporterbodowenzel Assigned Todregad  
PrioritylowSeveritytextReproducibilityN/A
Status closedResolutionfixed 
Product Version1.2.19 
Fixed in Version2.26.0 
Summary0021657: Development Guide - Chapter 4. Plugin System - Errors in text
Description

While making myself comfortable and following the walk through I found some errors:

Chapter 4.1:
The name of the class file is "MantisPlugin.class.php", not "MantisPlugin.php".

Chapter 4.2.2:
The name of the page file is "plugin.php", not "plugin_page.php".

Chapter 4.2.5 and 4.3.4, file "Example/pages/config_page.php":
In "<td class="form-title" rowspan="2">" the "rowspan" should be a "colspan".

Chapter 4.2.5 and 4.3.4, file "Example/pages/config_page.php", and 2 times:
At "<td class="category">" there is "<php" which should be "<?php".

Chapter 4.2.3 and 4.3.6, file "Example/page/foo.php":
Compared with the first version of the file in chapter 4.2.2 an "echo" was lost in line 3. Or the semicolon at the end of line 2 should be a comma.

Anyway, thanks for the concise and helpful guide!

Additional Information

Even if this issue is reported for 1.2.19 which I used, it is still valid for the on-line documentation of 1.3.x.

TagsNo tags attached.

Relationships

related to 0027992 closeddregad Remove helper_alternate_class() calls from Developers Guide and document alternative 

Activities

dregad

dregad

2023-08-06 18:41

developer   ~0067969

I believe most of the issues reported here were fixed in the 2021 review of the plugins section (see 0027992, MantisBT master 3868bdb9), except

Chapter 4.1:
The name of the class file is "MantisPlugin.class.php", not "MantisPlugin.php".

Which I'll address shortly.

Related Changesets

MantisBT: master 3868bdb9

2021-02-26 14:00

dregad


Details Diff		 Doc: improve Dev Guide Plugins section

- General revision and various improvements to the "Building a Plugin"
section
- Remove references to deprecated helper_alternate_class() function
- remove the "Example Plugin Source Listing" section, code is now hosted
in a GitHub repository in the mantisbt-plugins organization [1]
- Improve the Example Plugin; for details, see [1]

Fixes 0027992, 0027993

[1]: https://github.com/mantisbt-plugins/Example		 Affected Issues
0021657, 0027992, 0027993
mod - docbook/Developers_Guide/en-US/Plugins.xml Diff File
mod - docbook/Developers_Guide/en-US/Plugins_Building.xml Diff File
rm - docbook/Developers_Guide/en-US/Plugins_Building_Source.xml Diff

MantisBT: master 1232bc13

2023-08-06 18:42

dregad


Details Diff		 Dev Guide: fix incorrect file name in text

Fixes 0021657		 Affected Issues
0021657
mod - docbook/Developers_Guide/en-US/Plugins.xml Diff File