Skip to content

Generate Markdown: Update templates #1060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jshackell-sfdc wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Generate Markdown: Update templates #1060

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 74 additions & 100 deletions templates/command.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,100 +1,74 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="{{uniqueId 'cli_reference' commandWithUnderscores}}" xml:lang="en-us">
<!--

NOTE TO WRITERS:
THIS FILE IS AUTOGENERATED. DON’T MAKE CHANGES TO THIS FILE IN PERFORCE! YOUR CHANGES WILL BE OVERWRITTEN.
IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR DETAILS.

-->
{{!--Not all commands have a minor noun; some are just commandmajornoun:commandverb. This is a sample topic for a commmand with no minor noun.--}}
<title><codeph otherprops="nolang">{{name}}</codeph>{{#if isClosedPilotCommand}} (Pilot){{/if}}{{#if isOpenPilotCommand}} (Pilot){{/if}}{{#if isBetaCommand}} (Beta){{/if}}{{#if deprecated}} (Deprecated){{/if}}</title>
<shortdesc>
<ph id="shortdesc">
{{#if deprecated}}The command <codeph otherprops="nolang">{{name}}</codeph> has been deprecated{{#if deprecationOptions.version}} and will be removed in v{{deprecationOptions.version}} or later{{/if}}. {{#if deprecated.to}} Use <codeph otherprops="nolang">{{deprecated.to}}</codeph> instead. {{/if}} {{/if}}{{summary}}
</ph>
</shortdesc>
<prolog>
<metadata>
{{!--In the future we’ll add keywords here.--}}
<othermeta content="reference" name="topic_type"/>
<othermeta content="Developer_Tools" name="app_area"/>
<othermeta content="Developer Partner" name="role"/>
<othermeta content="EE UE DE PXE" name="edition"/>
<othermeta content="aloha mobile sfx" name="ui_platform"/>
</metadata>
</prolog>
<refbody>{{#if isClosedPilotCommand}}
<section>
<note>We provide the <codeph otherprops="nolang">{{name}}</codeph> command to selected customers through an invitation-only
pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t
guarantee acceptance. The <codeph otherprops="nolang">{{name}}</codeph> command isn’t generally available unless or
until Salesforce announces its general availability in documentation or in press
releases or public statements. We can’t guarantee general availability within any
particular time frame or at all. Make your purchase decisions only on the basis of
generally available products and features.</note>
</section>{{/if}}{{#if isOpenPilotCommand}}
</section>{{/if}}{{#if isOpenPilotCommand}}
<section>
<note>We provide the <codeph otherprops="nolang">{{name}}</codeph> command to selected customers through a pilot program
that requires agreement to specific terms and conditions. To be nominated to participate
in the program, contact Salesforce. Pilot programs are subject to change, and we can’t
guarantee acceptance. The <codeph otherprops="nolang">{{name}}</codeph> command isn’t generally available unless or
until Salesforce announces its general availability in documentation or in press
releases or public statements. We can’t guarantee general availability within any
particular time frame or at all. Make your purchase decisions only on the basis of
generally available products and features.</note>
</section>{{/if}}{{#if isBetaCommand}}
<section>
<note>This feature is a Beta Service. Customers may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms (<xref href="https://www.salesforce.com/company/legal/agreements/" format="html" scope="external" type="new-window:HTML">https://www.salesforce.com/company/legal/agreements/</xref>).</note>
</section>{{/if}}
{{#if help}}
<section>
<title><ph>Description for <codeph otherprops="nolang">{{name}}</codeph></ph></title>
{{#each help}}
{{#isCodeBlock this}}<codeblock otherprops="nolang">{{this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
{{/each}}
</section>
{{/if}}
{{#if examples}}
<section>
<title><ph>Examples for <codeph otherprops="nolang">{{name}}</codeph></ph></title>
{{#each examples}}
{{#if this.description}}<p>{{this.description}}</p>{{/if}}
{{#if this.commands}}
{{#each this.commands}}
{{#isCodeBlock this}}<codeblock otherprops="nolang">{{this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
{{/each}}
{{/if}}
{{/each}}
</section>
{{/if}}
{{#if parameters}}
<section>
<title><ph>Flags</ph></title>
<dl>
{{#each parameters}}
<dlentry>
<dt>{{#if char}}<codeph otherprops="nolang">-{{char}}</codeph> | {{/if}}<codeph otherprops="nolang">--{{name}}</codeph>{{#if hasValue}} <parmname>{{toUpperCase name}}</parmname>{{/if}}</dt>
{{#if deprecated}}<dd>The parameter <codeph otherprops="nolang">--{{name}}</codeph> has been deprecated and will be removed in v{{nextVersion deprecated.version}}.0 or later. Use <codeph otherprops="nolang">{{deprecated.to}}</codeph> instead.</dd>
{{/if}}<dd>{{#if optional}}Optional{{else}}Required{{/if}}</dd>
<dd>{{#each description}}<p>{{[]}}</p>{{/each}}</dd>{{#if kind}}
<dd>Type: {{kind}}</dd>{{/if}}{{#if options}}
<dd>Permissible values are: {{join options}}</dd>{{/if}}{{#if defaultFlagValue}}
<dd>Default value: {{defaultFlagValue}}</dd>{{/if}}
</dlentry>
{{/each}}
</dl>
</section>
{{/if}}
{{#if aliases}}
<section>
<title><ph>Aliases for <codeph otherprops="nolang">{{name}}</codeph></ph></title>
{{#each aliases}}
<codeblock otherprops="nolang">{{this}}</codeblock>
{{/each}}
</section>
{{/if}}
</refbody>
</reference>
{{!--Not all commands have a minor noun; some are just commandmajornoun:commandverb. This is a sample topic for a commmand with no minor noun.--}}
# {{name}}{{#if isClosedPilotCommand}} (Pilot){{/if}}{{#if isOpenPilotCommand}} (Pilot){{/if}}{{#if isBetaCommand}} (Beta){{/if}}{{#if deprecated}} (Deprecated){{/if}}
{{#if deprecated}}The command <codeph otherprops="nolang">{{name}}</codeph> has been deprecated{{#if deprecationOptions.version}} and will be removed in v{{deprecationOptions.version}} or later{{/if}}. {{#if deprecated.to}} Use <codeph otherprops="nolang">{{deprecated.to}}</codeph> instead. {{/if}} {{/if}}
{{summary}}

{{#if isClosedPilotCommand}}
:::note
We provide the <codeph otherprops="nolang">{{name}}</codeph> command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t guarantee acceptance. The <codeph otherprops="nolang">{{name}}</codeph> command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
:::

{{/if}}
{{#if isOpenPilotCommand}}
:::note
We provide the <codeph otherprops="nolang">{{name}}</codeph> command to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to change, and we can’t guarantee acceptance. The <codeph otherprops="nolang">{{name}}</codeph> command isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.</note>
:::

{{/if}}
{{#if isBetaCommand}}
:::note
This feature is a Beta Service. Customers may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms (<xref href="https://www.salesforce.com/company/legal/agreements/" format="html" scope="external" type="new-window:HTML">https://www.salesforce.com/company/legal/agreements/</xref>).
:::

{{/if}}
{{#if help}}
## Description for `{{name}}`

{{#each help}}
{{#isCodeBlock this}}`{{this}}`{{else}}{{this}}{{/isCodeBlock}}

{{/each}}
{{/if}}
{{#if examples}}
## Examples for `{{name}}`

{{#each examples}}
{{#if this.description}}{{this.description}}{{/if}}

{{#if this.commands}}
{{#each this.commands}}
{{#isCodeBlock this}}```bash
{{this}}
```{{else}}{this}}{{/isCodeBlock}}

{{/each}}
{{/if}}
{{/each}}
{{/if}}
{{#if parameters}}
## Flags

{{#each parameters}}
{{#if char}}`-{{char}}` | {{/if}}`--{{name}}`{{#if hasValue}} `{{toUpperCase name}}`{{/if}}

{{#if deprecated}}The parameter `--{{name}}` has been deprecated and will be removed in v{{nextVersion deprecated.version}}.0 or later. Use `{{deprecated.to}}` instead.

{{/if}}{{#if optional}}Optional{{else}}Required{{/if}}

{{#each description}}{{[]}}{{/each}}{{#if kind}}

Type: {{kind}}{{/if}}{{#if options}}

Permissible values are: {{join options}}{{/if}}{{#if defaultFlagValue}}

Default value: {{defaultFlagValue}}{{/if}}

{{/each}}
{{/if}}
{{#if aliases}}
## Aliases for `{{name}}`

{{#each aliases}}
`{{this}}`
{{/each}}
{{/if}}
Loading