Skip to Main Content
Feature Request FR-1960
Product Area Documentation
Status ROADMAP

32 Voters

Adding page documentation

ezequiel.fuentes Public · Sep 14 2021

Idea Summary
To be able to add the necessary documentation on each page.

Use Case
As a page is being created, it is necessary to document everything that is being done. Currently there is only the "comments" field for each page or element, but it is at the end of all properties and is very inaccessible. It would be much more convenient if the documentation could be viewed more quickly and directly. It would also be important that the text could be formatted (bold, italic, indented ...)

Preferred Solution (Optional)
There could be a new tab on each page, next to the existing ones (page search, help and layout)

This is currently on the roadmap for a future release of Oracle APEX.

Known Duplicates

Known duplicates

FR-3327
FR-3327 Comment Management Center

Comments

Comments

  • ino.laurensse OP 3.4 years ago

    Although we hardly document anything, I think it is a good idea. If I may make a suggestion:

    Change Comments to a rich text editor (or add a new tab and RTE item to Page, Region and Item).

    Add a document generator to extract Page → Region → Item level documentation.

  • stew stryker OP 2 years ago

    Great ideas here.

    Rather than an RTE field for comments, I'd prefer a Markdown editor, following the KISS principle.

    Add a document generator to extract Page ? Region ? Item level documentation.

    Or even an app-level documentation generator that converted the Markdown to HTML?

  • nikita.rambarransingh OP 2 years ago

    Good day all,

    I personally would stick with rich text over mark down.  Believe it or not, most of my developers dont inow the stntax, and I am bot so strong at it either.

    Sticking with a simple r8ch txt style editoer would make more people funtional at using the comments.

    As for a comments tab, good idea.

  • joep.hendrix OP 2 years ago

    Use an external tool (like Confluence) to document and add the link to the comments. 

    Add a document generator to extract Page → Region → Item level documentation.

    Good idea!