mirror of
https://github.com/MichaelGrafnetter/DSInternals
synced 2025-02-09 15:36:57 +00:00
58 lines
1.4 KiB
Markdown
58 lines
1.4 KiB
Markdown
|
# DSInternals
|
||
|
## about_DSInternals
|
||
|
|
||
|
```
|
||
|
ABOUT TOPIC NOTE:
|
||
|
The first header of the about topic should be the topic name.
|
||
|
The second header contains the lookup name used by the help system.
|
||
|
|
||
|
IE:
|
||
|
# Some Help Topic Name
|
||
|
## SomeHelpTopicFileName
|
||
|
|
||
|
This will be transformed into the text file
|
||
|
as `about_SomeHelpTopicFileName`.
|
||
|
Do not include file extensions.
|
||
|
The second header should have no spaces.
|
||
|
```
|
||
|
|
||
|
# SHORT DESCRIPTION
|
||
|
{{ Short Description Placeholder }}
|
||
|
|
||
|
```
|
||
|
ABOUT TOPIC NOTE:
|
||
|
About topics can be no longer than 80 characters wide when rendered to text.
|
||
|
Any topics greater than 80 characters will be automatically wrapped.
|
||
|
The generated about topic will be encoded UTF-8.
|
||
|
```
|
||
|
|
||
|
# LONG DESCRIPTION
|
||
|
{{ Long Description Placeholder }}
|
||
|
|
||
|
## Optional Subtopics
|
||
|
{{ Optional Subtopic Placeholder }}
|
||
|
|
||
|
# EXAMPLES
|
||
|
{{ Code or descriptive examples of how to leverage the functions described. }}
|
||
|
|
||
|
# NOTE
|
||
|
{{ Note Placeholder - Additional information that a user needs to know.}}
|
||
|
|
||
|
# TROUBLESHOOTING NOTE
|
||
|
{{ Troubleshooting Placeholder - Warns users of bugs}}
|
||
|
|
||
|
{{ Explains behavior that is likely to change with fixes }}
|
||
|
|
||
|
# SEE ALSO
|
||
|
{{ See also placeholder }}
|
||
|
|
||
|
{{ You can also list related articles, blogs, and video URLs. }}
|
||
|
|
||
|
# KEYWORDS
|
||
|
{{List alternate names or titles for this topic that readers might use.}}
|
||
|
|
||
|
- {{ Keyword Placeholder }}
|
||
|
- {{ Keyword Placeholder }}
|
||
|
- {{ Keyword Placeholder }}
|
||
|
- {{ Keyword Placeholder }}
|