Skip to content
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

Reword many fields, add explanations, move fields into different sections. #5

Merged
merged 5 commits into from
May 22, 2016
Merged

Reword many fields, add explanations, move fields into different sections. #5

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cdd505a
Reword many fields, add explanations, move fields into different sect…
mheguy May 20, 2016
2a17bb3
apply slightly edited #5
janbrohl May 22, 2016
528d66a
Merge branch 'rewording-b' into rewording
mheguy May 22, 2016
4e0da40
Change wording to be more specific
mheguy May 22, 2016
0e6b7b2
Modify supports definition
mheguy May 22, 2016
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
53 changes: 30 additions & 23 deletions static/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,32 +108,32 @@
</div>
</div>
<p>
Fields filled by the NetKAN indexer look like <input type="text" class="filled-by-netkan" disabled="disabled" /> - you can override auto-detection by setting a value yourself. <em>If unsure - don't override.</em>
Fields filled by the NetKAN indexer look like <input type="text" class="filled-by-netkan" disabled="disabled" /> - you can override auto-detection by setting a value yourself. <strong>If unsure - don't override.</strong>
</p>
<div id="accordion">
<h3>Mandatory</h3>
<div>
<ol id="mandatory_fields">
<li>
<label>Identifier - Machine-friendly name for the mod (only numbers, letters, and dashes, no spaces)<br /><input type="text" id="identifier" placeholder="AwesomeMod" size="40" pattern="^[A-Za-z][A-Za-z0-9-]*$" /></label> <em id="identifier_info"></em>
<label>Identifier - Machine-friendly name for the mod (only numbers, letters, and dashes, no spaces)<br /><input type="text" id="identifier" placeholder="AwesomeMod" size="40" pattern="^[A-Za-z][A-Za-z0-9-]*$" /></label> <strong id="identifier_info"></strong>
</li>
<li>
<label>Name - User-friendly name for the mod<br /><input type="text" id="name" placeholder="Awesome Mod" size="40" /></label> <em id="name_info"></em>
<label>Name - User-friendly name for the mod<br /><input type="text" id="name" placeholder="Awesome Mod" size="40" /></label> <strong id="name_info"></strong>
</li>
<li>
<label><input type="checkbox" id="add_vref" value="1" onchange="switch_add_vref()" /> Installs <code>.version</code> file</label>
</li>
<li>
<label>Mod version<br /><input type="text" id="version" size="40" /></label>
<label>Mod Version<br /><input type="text" id="version" size="40" /></label>
</li>
<li>
<label>Abstract - A short description of what the mod does<br /><textarea id="abstract" placeholder="Awesome mod makes everything better!" size="40"></textarea></label>
<label>Abstract - A short description of what the mod does<br /><textarea id="abstract" placeholder="Awesome mod makes everything better!" cols="40" ></textarea></label>
</li>
<li>
<label>Download URL<br /><input type="url" id="download" size="40" /></label>
<label>Download URI<br /><input type="url" id="download" size="40" /></label>
</li>
<li>
<label>Mod author(s) (one per line)<br /><textarea id="author" cols="40"></textarea></label>
<label>Mod Authors (one per line)<br /><textarea id="author" cols="40"></textarea></label>
</li>
<li>
<label>License(s)<br /><textarea id="license" cols="40"></textarea></label>
Expand All @@ -147,42 +147,48 @@ <h3>Mandatory</h3>
</li>
<li>
<label>KSP-Version<br /><input type="text" id="ksp_version" size="40" /></label> examples: <code>==1.0</code> or <code>&lt;=1.1&gt;=1.0.3</code>
<br />
<small>While not technically mandatory, not providing this field is considered bad practice.</small>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth noting that if/when KSP-CKAN/CKAN#1742 is merged this will be technically mandatory.

</li>

</ol>
</div>
<h3>Resources (suggested)</h3>
<h3>Resources (Suggested)</h3>
<div id="resources_fields">
<ol>
<li>
<label>Homepage<br /><input type="url" id="resources_homepage" size="40" /></label> The preferred landing page for the mod
<label>Homepage<br /><input type="url" id="resources_homepage" size="40" /></label> URI to the preferred landing page for the mod
</li>
<li>
<label>Repository<br /><input type="url" id="resources_repository" size="40" /></label> The repository where the mod's source can be found
</li>
<label>Repository<br /><input type="url" id="resources_repository" size="40" /></label> URI to the repository where the mod's source can be found
</li>
<li>
<label>Bugtracker<br /><input type="url" id="resources_bugtracker" size="40" /></label> The mod's bugtracker if it exists
<label>CI<br /><input type="url" id="resources_ci" size="40" /></label> Continuous Integration (e.g. Jenkins) Server where the module is being built
</li>
<li>
<label>CI<br /><input type="url" id="resources_ci" size="40" /></label> Continuous Integration (e.g. Jenkins) Server where the module is being built
<label>SpaceDock<br /><input type="url" id="resources_spacedock" size="40" /></label> URI to the mod's SpaceDock page
</li>
<li>
<label>SpaceDock<br /><input type="url" id="resources_spacedock" size="40" /></label> The mod's SpaceDock page
<label>Manual<br /><input type="url" id="resources_manual" size="40" /></label> URI to the mod's user manual if it exists
</li>
<li>
<label>Manual<br /><input type="url" id="resources_manual" size="40" /></label> The mod's user manual if it exists
<label>License<br /><input type="url" id="resources_license" size="40" /></label> URI to the mod's license
</li>
<li>
<label>License<br /><input type="url" id="resources_license" size="40" /></label> A URL to the mod's license
<label>Bugtracker<br /><input type="url" id="resources_bugtracker" size="40" /></label> URI to the mod's bugtracker if it exists (Preferred page to post problems/questions)
</li>
<li>
<label>Screenshot<br /><input type="url" id="resources_x_screenshot" size="40" /></label> A direct URL to a screenshot of the mod
</li>
</ol>
</div>
<h3>Install instructions</h3>
<h3>Installation</h3>
<div id="install_fields">
<ol> If this mod requires other mods to be installed alongside it, use Relationships.<b>Do not use install instructions to install multiple mods.</b>
<p>
If this mod requires other mods to be installed alongside it, use Relationships.
<strong>Do not use install instructions to install multiple mods.</strong>
</p>
<ol>
<li>
<label>Install from<br /><input type="text" id="file" size="40" /></label>
</li>
Expand Down Expand Up @@ -247,7 +253,7 @@ <h3>Relationships</h3>
</div>
</li>
<li>
<label>Supports (mod has specific code to relating to these mods)<br /><textarea id="supports" cols="40"></textarea></label>
<label>Supports (mod has specific code to relating to these mods or is known to play well with them)<br /><textarea id="supports" cols="40"></textarea></label>
Copy link
Contributor Author

@mheguy mheguy May 22, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or is known to play well with them

Any 2 mods that don't have an explicit conflicts set have this type of implicit supports. See KSP-CKAN/CKAN#1574 (comment) for a more complete explanation.

<button type="button" id="add_supports_button">Add</button>
<div id="add_supports" title="Add supported">
<div class="ui-widget">
Expand All @@ -260,7 +266,7 @@ <h3>Relationships</h3>
</li>

<li>
<label>Conflicts with (mod will be break or be broken by these mods)<br /><textarea id="conflicts" cols="40"></textarea></label>
<label>Conflicts with (mod will break or will break these mods)<br /><textarea id="conflicts" cols="40"></textarea></label>
<button type="button" id="add_conflicts_button">Add</button>
<div id="add_conflicts" title="Add conflicted">
<div class="ui-widget">
Expand All @@ -277,7 +283,7 @@ <h3>Advanced</h3>
<div id="advanced_fields">
<ol>
<li>
<label>Provides - advanced field that lets mods be interchangeable<br /><textarea id="provides" cols="40"></textarea></label>
<label>Provides (can be installed instead of these mods without problems)<br /><textarea id="provides" cols="40"></textarea></label>
<button type="button" id="add_provides_button">Add</button>
<div id="add_provides" title="Add provided">
<div class="ui-widget">
Expand All @@ -289,8 +295,9 @@ <h3>Advanced</h3>
</div>
</li>
<li>
<label><input type="checkbox" id="add_ksp_version_strict" value="1" size="40" /> Install only on exact KSP-Version match - advanced field in cases where mods are not compatible with small KSP patches/hotfixes</label>
<label><input type="checkbox" id="add_ksp_version_strict" value="1" size="40" /> Install only on exact KSP-Version match</label> in case this mods is not compatible with small KSP patches/hotfixes
</li>

</ol>
</div>
<h3>Don't Touch</h3>
Expand All @@ -300,7 +307,7 @@ <h3>Don't Touch</h3>
<label>$kref<br /><input type="text" id="kref" size="40" /></label>
</li>
<li>
<label>Update JSON<br /><textarea id="update_json" size="40">{}</textarea></label>
<label>Update JSON<br /><textarea id="update_json" cols="40">{}</textarea></label>
</li>
</ol>
</div>
Expand Down