Skip to content

Ability to use Markdown for Admin Help display in modules #547

Description

@zyspec

Enhancement

Instead of hand coding the ./language/{language}/help pages it would be preferable to have something like \Xmf\Module\Admin methods to allow module developers to create the document(s) using class methods. The thought is to wrap something like Parsedown into a Xmf (or XOOPs) class. We could then create rich documents more easily and theoretically have these translated much more easily using Transifex.

Obviously we'd want/need to maintain backward compatibility but we should be able to check for an additional file extension in the file loader to see if the markup file exists in addition to checking for the .html & .tpl files it looks for now and manipulate it accordingly.

It should be relatively easy to include a jscript Markdown editor (something like SimpleMDE in the TDMCreate module to allow developers the ability to create the help file too.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions