Skip to content

Commit aa7a86d

Browse files
jshackell-sfdcjshackell-sfdc
authored
in-progress update to generate markdown.
1 parent 11196cd commit aa7a86d

1 file changed

Lines changed: 74 additions & 100 deletions

File tree

‎templates/command.hbs‎

Lines changed: 74 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,74 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3-
<reference id="{{uniqueId 'cli_reference' commandWithUnderscores}}" xml:lang="en-us">
4-
<!--
5-
6-
NOTE TO WRITERS:
7-
THIS FILE IS AUTOGENERATED. DON’T MAKE CHANGES TO THIS FILE IN PERFORCE! YOUR CHANGES WILL BE OVERWRITTEN.
8-
IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR DETAILS.
9-
10-
-->
11-
{{!--Not all commands have a minor noun; some are just commandmajornoun:commandverb. This is a sample topic for a commmand with no minor noun.--}}
12-
<title><codeph otherprops="nolang">{{name}}</codeph>{{#if isClosedPilotCommand}} (Pilot){{/if}}{{#if isOpenPilotCommand}} (Pilot){{/if}}{{#if isBetaCommand}} (Beta){{/if}}{{#if deprecated}} (Deprecated){{/if}}</title>
13-
<shortdesc>
14-
<ph id="shortdesc">
15-
{{#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}}
16-
</ph>
17-
</shortdesc>
18-
<prolog>
19-
<metadata>
20-
{{!--In the future we’ll add keywords here.--}}
21-
<othermeta content="reference" name="topic_type"/>
22-
<othermeta content="Developer_Tools" name="app_area"/>
23-
<othermeta content="Developer Partner" name="role"/>
24-
<othermeta content="EE UE DE PXE" name="edition"/>
25-
<othermeta content="aloha mobile sfx" name="ui_platform"/>
26-
</metadata>
27-
</prolog>
28-
<refbody>{{#if isClosedPilotCommand}}
29-
<section>
30-
<note>We provide the <codeph otherprops="nolang">{{name}}</codeph> command to selected customers through an invitation-only
31-
pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can’t
32-
guarantee acceptance. The <codeph otherprops="nolang">{{name}}</codeph> command isn’t generally available unless or
33-
until Salesforce announces its general availability in documentation or in press
34-
releases or public statements. We can’t guarantee general availability within any
35-
particular time frame or at all. Make your purchase decisions only on the basis of
36-
generally available products and features.</note>
37-
</section>{{/if}}{{#if isOpenPilotCommand}}
38-
</section>{{/if}}{{#if isOpenPilotCommand}}
39-
<section>
40-
<note>We provide the <codeph otherprops="nolang">{{name}}</codeph> command to selected customers through a pilot program
41-
that requires agreement to specific terms and conditions. To be nominated to participate
42-
in the program, contact Salesforce. Pilot programs are subject to change, and we can’t
43-
guarantee acceptance. The <codeph otherprops="nolang">{{name}}</codeph> command isn’t generally available unless or
44-
until Salesforce announces its general availability in documentation or in press
45-
releases or public statements. We can’t guarantee general availability within any
46-
particular time frame or at all. Make your purchase decisions only on the basis of
47-
generally available products and features.</note>
48-
</section>{{/if}}{{#if isBetaCommand}}
49-
<section>
50-
<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>
51-
</section>{{/if}}
52-
{{#if help}}
53-
<section>
54-
<title><ph>Description for <codeph otherprops="nolang">{{name}}</codeph></ph></title>
55-
{{#each help}}
56-
{{#isCodeBlock this}}<codeblock otherprops="nolang">{{this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
57-
{{/each}}
58-
</section>
59-
{{/if}}
60-
{{#if examples}}
61-
<section>
62-
<title><ph>Examples for <codeph otherprops="nolang">{{name}}</codeph></ph></title>
63-
{{#each examples}}
64-
{{#if this.description}}<p>{{this.description}}</p>{{/if}}
65-
{{#if this.commands}}
66-
{{#each this.commands}}
67-
{{#isCodeBlock this}}<codeblock otherprops="nolang">{{this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
68-
{{/each}}
69-
{{/if}}
70-
{{/each}}
71-
</section>
72-
{{/if}}
73-
{{#if parameters}}
74-
<section>
75-
<title><ph>Flags</ph></title>
76-
<dl>
77-
{{#each parameters}}
78-
<dlentry>
79-
<dt>{{#if char}}<codeph otherprops="nolang">-{{char}}</codeph> | {{/if}}<codeph otherprops="nolang">--{{name}}</codeph>{{#if hasValue}} <parmname>{{toUpperCase name}}</parmname>{{/if}}</dt>
80-
{{#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>
81-
{{/if}}<dd>{{#if optional}}Optional{{else}}Required{{/if}}</dd>
82-
<dd>{{#each description}}<p>{{[]}}</p>{{/each}}</dd>{{#if kind}}
83-
<dd>Type: {{kind}}</dd>{{/if}}{{#if options}}
84-
<dd>Permissible values are: {{join options}}</dd>{{/if}}{{#if defaultFlagValue}}
85-
<dd>Default value: {{defaultFlagValue}}</dd>{{/if}}
86-
</dlentry>
87-
{{/each}}
88-
</dl>
89-
</section>
90-
{{/if}}
91-
{{#if aliases}}
92-
<section>
93-
<title><ph>Aliases for <codeph otherprops="nolang">{{name}}</codeph></ph></title>
94-
{{#each aliases}}
95-
<codeblock otherprops="nolang">{{this}}</codeblock>
96-
{{/each}}
97-
</section>
98-
{{/if}}
99-
</refbody>
100-
</reference>
1+
{{!--Not all commands have a minor noun; some are just commandmajornoun:commandverb. This is a sample topic for a commmand with no minor noun.--}}
2+
# {{name}}{{#if isClosedPilotCommand}} (Pilot){{/if}}{{#if isOpenPilotCommand}} (Pilot){{/if}}{{#if isBetaCommand}} (Beta){{/if}}{{#if deprecated}} (Deprecated){{/if}}
3+
{{#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}}
4+
{{summary}}
5+
6+
{{#if isClosedPilotCommand}}
7+
:::note
8+
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.
9+
:::
10+
11+
{{/if}}
12+
{{#if isOpenPilotCommand}}
13+
:::note
14+
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>
15+
:::
16+
17+
{{/if}}
18+
{{#if isBetaCommand}}
19+
:::note
20+
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>).
21+
:::
22+
23+
{{/if}}
24+
{{#if help}}
25+
## Description for `{{name}}`
26+
27+
{{#each help}}
28+
{{#isCodeBlock this}}`{{this}}`{{else}}{{this}}{{/isCodeBlock}}
29+
30+
{{/each}}
31+
{{/if}}
32+
{{#if examples}}
33+
## Examples for `{{name}}`
34+
35+
{{#each examples}}
36+
{{#if this.description}}{{this.description}}{{/if}}
37+
38+
{{#if this.commands}}
39+
{{#each this.commands}}
40+
{{#isCodeBlock this}}```bash
41+
{{this}}
42+
```{{else}}{this}}{{/isCodeBlock}}
43+
44+
{{/each}}
45+
{{/if}}
46+
{{/each}}
47+
{{/if}}
48+
{{#if parameters}}
49+
## Flags
50+
51+
{{#each parameters}}
52+
{{#if char}}`-{{char}}` | {{/if}}`--{{name}}`{{#if hasValue}} `{{toUpperCase name}}`{{/if}}
53+
54+
{{#if deprecated}}The parameter `--{{name}}` has been deprecated and will be removed in v{{nextVersion deprecated.version}}.0 or later. Use `{{deprecated.to}}` instead.
55+
56+
{{/if}}{{#if optional}}Optional{{else}}Required{{/if}}
57+
58+
{{#each description}}{{[]}}{{/each}}{{#if kind}}
59+
60+
Type: {{kind}}{{/if}}{{#if options}}
61+
62+
Permissible values are: {{join options}}{{/if}}{{#if defaultFlagValue}}
63+
64+
Default value: {{defaultFlagValue}}{{/if}}
65+
66+
{{/each}}
67+
{{/if}}
68+
{{#if aliases}}
69+
## Aliases for `{{name}}`
70+
71+
{{#each aliases}}
72+
`{{this}}`
73+
{{/each}}
74+
{{/if}}

0 commit comments

Comments
 (0)