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 1 commit
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
63 changes: 28 additions & 35 deletions static/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,28 +115,28 @@ <h3>Mandatory</h3>
<div>
<ol id="mandatory_fields">
<li>
<label>Identifier<br /><input type="text" id="identifier" placeholder="Machine-friendly name for the mod" 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> <em id="identifier_info"></em>
</li>
<li>
<label>Name<br /><input type="text" id="name" placeholder="User-friendly name for the 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> <em id="name_info"></em>
</li>
<li>
<label><input type="checkbox" id="add_vref" value="1" onchange="switch_add_vref()" /> Installs <code>.version</code> file</label>
</li>
<li>
<label>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<br /><textarea id="abstract" placeholder="A short description of what the mod does" size="40"></textarea></label>
<label>Abstract - A short description of what the mod does<br /><textarea id="abstract" placeholder="Awesome mod makes everything better!" size="40"></textarea></label>
</li>
<li>
<label>Download<br /><input type="url" id="download" size="40" /></label>
<label>Download URL<br /><input type="url" id="download" size="40" /></label>
</li>
<li>
<label>Authors (one per line)<br /><textarea id="author" cols="40"></textarea></label>
<label>Mod author(s) (one per line)<br /><textarea id="author" cols="40"></textarea></label>
</li>
<li>
<label>Licenses<br /><textarea id="license" cols="40"></textarea></label>
<label>License(s)<br /><textarea id="license" cols="40"></textarea></label>
<button type="button" id="add_license_button">Add</button> Users can choose to which of these to adhere
<div id="add_license" title="Add license">
<a href="https://github.com/KSP-CKAN/CKAN/blob/master/Spec.md#license" target="_blank">About valid licenses</a>
Expand All @@ -145,29 +145,20 @@ <h3>Mandatory</h3>
</div>
</div>
</li>

</ol>
</div>
<h3>Extra Info (suggested)</h3>
<div id="extra_fields">
<ol>
<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>
</li>
<li>
<label><input type="checkbox" id="add_ksp_version_strict" value="1" size="40" /> Install only on exact KSP-Version match</label>
</li>
</ol>

</ol>
</div>
<h3>Ressources (suggested)</h3>
<h3>Resources (suggested)</h3>
<div id="resources_fields">
<ol>
<li>
<label>Repository<br /><input type="url" id="resources_repository" size="40" /></label> The repository where the module source can be found
<label>Homepage<br /><input type="url" id="resources_homepage" size="40" /></label> The preferred landing page for the mod
</li>
<li>
<label>Homepage<br /><input type="url" id="resources_homepage" size="40" /></label> The preferred landing page for the mod
<label>Repository<br /><input type="url" id="resources_repository" size="40" /></label> 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
Expand All @@ -176,24 +167,24 @@ <h3>Ressources (suggested)</h3>
<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>SpaceDock<br /><input type="url" id="resources_spacedock" size="40" /></label> The mod on SpaceDock
<label>SpaceDock<br /><input type="url" id="resources_spacedock" size="40" /></label> The mod's SpaceDock page
</li>
<li>
<label>Manual<br /><input type="url" id="resources_manual" size="40" /></label> The mod's bugtracker if it exists
<label>Manual<br /><input type="url" id="resources_manual" size="40" /></label> The mod's user manual if it exists
</li>
<li>
<label>License<br /><input type="url" id="resources_license" size="40" /></label> The mod's license
<label>License<br /><input type="url" id="resources_license" size="40" /></label> A URL to the mod's license
</li>
<li>
<label>Screenshot<br /><input type="url" id="resources_x_screenshot" size="40" /></label>
<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>Special Install</h3>
<h3>Install instructions</h3>
<div id="install_fields">
<ol>
<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>
Copy link
Contributor Author

@mheguy mheguy May 20, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

This line in particular probably needs an edit since I imagine this text should be inside some kind of element.

<li>
<label>Install Root<br /><input type="text" id="file" size="40" /></label>
<label>Install from<br /><input type="text" id="file" size="40" /></label>
</li>
<li>
<label>
Expand All @@ -213,14 +204,14 @@ <h3>Special Install</h3>
</li>
</ol>
</div>
<h3>References</h3>
<h3>Relationships</h3>
<div id="references_fields">
<p>
You can add version restrictions. For example <code>SomeModID</code> can be restricted like <code>SomeModID ==1.0</code> or <code>SomeModID &lt;=1.1 &gt;=1.0.3</code>
</p>
<ol>
<li>
<label>Depends on<br /><textarea id="depends" cols="40"></textarea></label>
<label>Depends on (mod will not run without it)<br /><textarea id="depends" cols="40"></textarea></label>
<button type="button" id="add_depends_button">Add</button>
<div id="add_depends" title="Add requirement">
<div class="ui-widget">
Expand All @@ -232,7 +223,7 @@ <h3>References</h3>
</div>
</li>
<li>
<label>Recommends<br /><textarea id="recommends" cols="40"></textarea></label>
<label>Recommends (mod is greatly complimented by these mods)<br /><textarea id="recommends" cols="40"></textarea></label>
<button type="button" id="add_recommends_button">Add</button>
<div id="add_recommends" title="Add recommendation">
<div class="ui-widget">
Expand All @@ -244,7 +235,7 @@ <h3>References</h3>
</div>
</li>
<li>
<label>Suggests<br /><textarea id="suggests" cols="40"></textarea></label>
<label>Suggests (mod is complimented by these mods)<br /><textarea id="suggests" cols="40"></textarea></label>
<button type="button" id="add_suggests_button">Add</button>
<div id="add_suggests" title="Add suggestion">
<div class="ui-widget">
Expand All @@ -256,7 +247,7 @@ <h3>References</h3>
</div>
</li>
<li>
<label>Supports<br /><textarea id="supports" cols="40"></textarea></label>
<label>Supports (mod has specific code to relating to these mods)<br /><textarea id="supports" cols="40"></textarea></label>
<button type="button" id="add_supports_button">Add</button>
<div id="add_supports" title="Add supported">
<div class="ui-widget">
Expand All @@ -269,7 +260,7 @@ <h3>References</h3>
</li>

<li>
<label>Conflicts with<br /><textarea id="conflicts" cols="40"></textarea></label>
<label>Conflicts with (mod will be break or be broken by 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 @@ -286,7 +277,7 @@ <h3>Advanced</h3>
<div id="advanced_fields">
<ol>
<li>
<label>Provides<br /><textarea id="provides" cols="40"></textarea></label>
<label>Provides - advanced field that lets mods be interchangeable<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 @@ -297,7 +288,9 @@ <h3>Advanced</h3>
</div>
</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>
</li>
</ol>
</div>
<h3>Don't Touch</h3>
Expand Down