symphonists/documenter

Symphony extension that allows users to add documentation to back-end pages

documenter's Issues

Sorting entries

It would be great to be able to sort documentation entries just like you can sort Sections in the overview.

2.2.1 compatibility says 'unsure', should say 'compatible' =)

Just tested, works like a charm =)

Section attached to System

If you attach a section to the System tab, it seems like Documenter doesn't recognize the different modes like new and edit. It's only possible to add documentation to the index view of these sections.

[Feature Request] Add Documentation to Pages in Blueprints > Pages area

This is half feature request, half advice request.

I would like to be able to add documentation to a given page that I had created under Blueprints > Pages but they are not available in the multi-select. From the outside looking in, this doesn't look like an impossible task. I think I would need to call up all the pages that have been made to add to the multi-select, add the drawer and button to the individual Page page (this is sort of foggy), generate the correct URL for storage (shouldn't be hard?)... Am I getting this right? Am I going to run into a brick wall if I look at this too hard or should I go ahead and see if I can get this feature added? Would anyone else even use this feature?

Thanks for reading.

Saving a documentation entry without selecting a section renders an error

Fatal error: Call to undefined method contentExtensionDocumenterNew::wrapFormElementWithError() in
/…/extensions/documenter/lib/class.form.php on line 142

Preferences UI initial Text Formatter setting is None

v2.4.3, Sym 2.6.11, PHP 5.6.31, MySQL 5.5.52

It's not clear what is allowed in the Content field. The README suggests HTML, however the Auto-generate content ... button inputs Markdown headings (also, ## and not ###).

HTML works but Markdown does not. It would be great if Markdown was allowed in the Content field.

Scratch that, I've edited the title of this issue. I found a setting in Preferences to specify Markdown. However, the initial Text Formatter setting of None seems irrelevant in the drop-down, unless you know the specific wrapper/class to assign to H3 to make them collapse. The README should mention about setting Markdown in Preferences and/or Markdown ought to be pre-selected because the Auto-generate content ... button inputs Markdown headings.

Error when trying to create new entry (Symphony 2.6.7 + Documenter 2.4.0)

I get the following error when trying to create a new documenter entry with the abovementioned setup:

Symphony Fatal Error: Call to undefined method contentExtensionDocumenterNew::Error()
An error occurred in .../extensions/documenter/lib/class.form.php around line 106

I went back to documenter version 2.3.0 and that worked!

Help button layout apparently broken in Symphony 2.7beta2

CKEditor is not working

When I choose another text formatter (like CKEditor) it's not rendered.

Documenter not available to custom datasources

I have added a Documenter entry and attached it to every available Datasource page (new, edit, info, and root) and I still cannot get it to show for custom datasources. I would like to explain when someone lands on the page of a datasource that cannot be edited with the GUI, that they need to go into the files and edit the code. I thought this page would be the "info" page since that is what shows in the URL, but adding documentation to that doesn't seem to work.

Is it just me this doesn't work for? Is there a secret item in the select list I need to choose? Is this kind of page out of reach of Documenter?

Thanks for reading.

2.4+ Compatibility

Attachment to page fail

I'm experiencing a weird bug, where, attaching a documentation to more than 10 or 11 pages is not possible. I'm using Symphony 2.2.5.

Styling Compatibility w/ Subsection Manager

An open Documenter drawer breaks SSM Layout, even if the current page has no documentation attached. Apparently the styling is added as an attribute.

Collation Encoding not set

Quoting Brendo »That error is probably because the CREATE TABLE statement doesn't specify the table collation or character set to be UTF-8, so the table has most likely been creating using MySQL's horrible default of latin1, which will eat unicode characters.«

saveConfig has been removed.

Administration::instance()->saveConfig has been removed, use Symphony::Configuration()->write()

public function uninstall() {
Symphony::Database()->query("DROP TABLE tbl_documentation;");
Symphony::Configuration()->remove('text-formatter', 'documentation');
Symphony::Configuration()->remove('button-text', 'documentation');
Symphony::Configuration()->write();
}

    public function install() {
        Symphony::Database()->query(
            "CREATE TABLE `tbl_documentation` (
                `id` int(11) unsigned NOT NULL auto_increment,
                `title` varchar(255),
                `pages` text,
                `content` text,
                `content_formatted` text,
                PRIMARY KEY (`id`)
            ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;"
  );
        Symphony::Configuration()->set('text-formatter', 'none', 'documentation');
        Symphony::Configuration()->set('button-text', __('Documentation'), 'documentation');
        Symphony::Configuration()->write();
        return;
    }