Does UE4 support Plugins with a Documentation Folder for UDN Files

StormDragon18 · October 16, 2021, 6:14am

I have multiple plugins that I would like the UE4 Editor to support tooltips, along with the extended tooltips Documentation Link when you use CTRL+ALT. How can you configure the engine to look in a plugin to get these files, or does a user have to manually copy them into the engine files. If it’s not supported, can this be an enhancement request?

To reproduce Open any Blueprint with an Event Graph, Hover the mouse over the Event Graph in the My Blueprint tree, Notice how the tooltip has an option for a ctrl+alt for more details, they will show you a hyperlink to open the docs. We have custom Nodes, where we want to be able to link directly to a doc source. Currently, they just show the name of the Node.

You can see how Epic describes their internal guidelines. /Engine/Documentation/Source/DocumentationGuidelines/DocumentationGuidelines.INT.udn

or someone has the source up on GitHub (not me)

github.com

raysjoshua/UnrealEngine/blob/master/Engine/Documentation/Source/DocumentationGuidelines/DocumentationGuidelines.INT.udn

Availability:Docs
Title: Documentation Process & Guidelines
Crumbs:
Description:Style and syntax guidelines for writing documentation.

For Unreal Engine 4 (UE4) documentation, custom extended markdown syntax is used and the files are stored in P4 with the engine. Hopefully, this means it will be easier to jump in and add/update documentation.

The basic workflow when creating or editing documentation is:

* Edit/Add a markdown file (`.udn`)
* Preview the page as HTML
* Repeat until you are happy with it and there are no errors
* Check-in the markdown file (use the `#doc` P4 tag for major changes/additions so we get alerted for tracking purposes)


## Markdown Files

The source markdown files are stored in P4 (at `//depot/UE4/Engine/Documentation/Source/`) and available directly in the UE4 solution in Visual Studio under the Documentation project. These files all use the .udn file extension so they are easily identified. They also contain the language code in the name, so all English markdown files are named `*.INT.udn`, Korean files are named `*.KOR.udn`, etc. You will only ever add or edit `*.INT.udn` files. The other languages are handled by the localization teams.

Since the files are in the solution, it is really easy to find and edit existing files. New files can be added through VS or manually. Just make sure you update the Documentation project files when adding new files manually using the new project file generator.

This file has been truncated. show original