Skip to content

Commit

Permalink
Some linkage display changes for licensing
Browse files Browse the repository at this point in the history 
* Make the sample keys collapsible... *bootstrap* bling but also conserves some screen real-estate
* Move some linkage around too in respective areas.
* Added `@version` since someone mentioned they didn't know that at one point.

Applies to OpenUserJS#438
  • Loading branch information
@Martii
Martii committed Nov 3, 2017
1 parent d996236 commit ad12cc0
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 37 deletions.
5 changes: 3 additions & 2 deletions views/includes/documents/Terms-of-Service.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ Within moderation we understand the occasional necessity to conserve device stor

#### Default Code Licensing

* User Scripts have an implied license of [MIT License (Expat)][osiMITLicenseExpat] if the `@license` *(including the alternate spelling of `@licence`)* metadata block key is absent.
* Library Scripts need to include one reference to their [acceptable license(s)][oujsAcceptableLicensing] either via a License Header *([sample MPL header][mozMPLHeaders] if that license is chosen)*, a cross-site compatible metadata block with at least one `@license` or `@licence` key **and** one `@exclude *`, or full License text *(full text is not recommended for storage constraints on portable devices)*. Libraries also have an implied license of [MIT License (Expat)][osiMITLicenseExpat] in the absence of any licensing *(however this should not happen)*. It may also be useful to indicate in the source that it is a library and not a userscript. If the type of script is unclear the library may be subject to removal.
* User Scripts have an implied license of [`MIT`][spdxMITLicense] [License *(Expat)*][osiMITLicenseExpat] if the `@license` *(including the alternate spelling of `@licence`)* metadata block key is absent.
* Library Scripts need to include one reference to their [acceptable license(s)][oujsAcceptableLicensing] either via a License Header *([sample MPL header][mozMPLHeaders] if that license is chosen)*, a cross-site compatible metadata block with at least one `@license` or `@licence` key **and** one `@exclude *`, or full License text *(full text is not recommended for storage constraints on portable devices)*. Libraries also have an implied license of [`MIT`][spdxMITLicense] [License *(Expat)*][osiMITLicenseExpat] in the absence of any licensing *(however this should not happen)*. It may also be useful to indicate in the source that it is a library and not a userscript. If the type of script is unclear the library may be subject to removal.

#### Acceptable Licensing
* Licensing must be [Open Source Initiative *(OSI)* approved][osiApprovedLicenses] and declared with the name of the License in the Source Code for all published works. e.g. `@license` or `@licence` keys, License Header or full License text *(full text is not recommended for storage constraints on portable devices)*
Expand Down Expand Up @@ -69,6 +69,7 @@ OpenUserJs.org reserves the right to amend these terms at any time.
[mozMPLHeaders]: https://www.mozilla.org/MPL/headers/
[oujsDefaultCodeLicensing]: #default-code-licensing
[oujsAcceptableLicensing]: #acceptable-licensing
[spdxMITLicense]: https://spdx.org/licenses/MIT.html
[osiMITLicenseExpat]: https://opensource.org/licenses/MIT
[osiApprovedLicenses]: https://opensource.org/licenses/category
[osiPublicDomain]: https://opensource.org/faq#public-domain
138 changes: 104 additions & 34 deletions views/pages/newScriptPage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,54 +21,124 @@
<h2><i class="octicon octicon-key"></i> Script Metadata</h2>
<div class="panel panel-default">
<div class="panel-body">
<p>You may read about most UserScript metadata block keys on the <a href="https://wiki.greasespot.net/Metadata_Block">Greasespot wiki</a> and at the <a href="https://sourceforge.net/p/greasemonkey/wiki/Metadata_Block/">Greasemonkey on SourceForge wiki</a>. Some recommended ones are listed below with their respective metadata block names.</p>
<p>You may read about most UserScript metadata block keys on the <a href="https://wiki.greasespot.net/Metadata_Block">Greasespot wiki</a> and at the <a href="https://sourceforge.net/p/greasemonkey/wiki/Metadata_Block/">Greasemonkey on SourceForge classic wiki</a>. Some samples to click and read <noscript>, with JavaScript enabled,</noscript> are listed below with their respective metadata block names.</p>
</div>
</div>
<h3>UserScript Block</h3>
<div class="list-group script-metadata-definitions">
<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@name My Script</code></h5>
<p class="list-group-item-text"><strong>Default non-localized is required.</strong> Last value is used.</p>
<div class="panel-group" id="accordion-userscript-block">

<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-userscript-block" href="#collapse-name"><code>@name My Script</code></a>
</h5>
</div>
<div id="collapse-name" class="panel-collapse collapse in">
<div class="panel-body"><strong>Default non-localized is required.</strong> Last value is used.</div>
</div>
</div>
<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@updateURL https://openuserjs.org/meta/{{#authedUser}}{{authedUser.name}}{{/authedUser}}{{^authedUser}}username{{/authedUser}}/My_Script.meta.js</code></h5>
<p class="list-group-item-text"><strong>Required in lockdown mode.</strong> See <a href="/about/Frequently-Asked-Questions#q-does-openuserjs-org-have-meta-">this FAQ item</a> for more. Last value is used.</p>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-userscript-block" href="#collapse-description"><code>@description This script even does the laundry!</code></a>
</h5>
</div>
<div id="collapse-description" class="panel-collapse collapse">
<div class="panel-body">Specially formatted on the script page. Last value shown.</div>
</div>
</div>
<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@description This script even does the laundry!</code></h5>
<p class="list-group-item-text">Specially formatted on the script page. Last value shown.</p>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-userscript-block" href="#collapse-copyright"><code>@copyright Year, Author (Author Website)</code></a>
</h5>
</div>
<div id="collapse-copyright" class="panel-collapse collapse">
<div class="panel-body">Specially formatted on the script page. All values shown in reverse order.</div>
</div>
</div>

<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@copyright Year, Author (Author Website)</code></h5>
<p class="list-group-item-text">Specially formatted on the script page. All values shown in reverse order.</p>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-userscript-block" href="#collapse-license"><code>@license License Type; License Homepage</code></a>
</h5>
</div>
<div id="collapse-license" class="panel-collapse collapse">
<div class="panel-body">Specially formatted on the script page. All values shown in reverse order. If absent <a href="https://spdx.org/licenses/MIT.html"><code>MIT</code></a> <a href="https://opensource.org/licenses/MIT">License <em>(Expat)</em></a> is implied. See <a href="/about/Terms-of-Service#licensing">licensing terms</a> for specifics.</div>
</div>
</div>
<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@icon url</code></h5>
<p class="list-group-item-text">A url or data url. Resolution should be near 48px by 48px, Used in the script list page at 16px and on the script page at ~45px. Last value is shown.</p>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-userscript-block" href="#collapse-icon"><code>@icon url</code></a>
</h5>
</div>
<div id="collapse-icon" class="panel-collapse collapse">
<div class="panel-body">A url or data url. Resolution should be near 48px by 48px, Used in the script list page at 16px and on the script page at ~45px. Last value is shown.</div>
</div>
</div>
<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@license License Type; License Homepage</code></h5>
<p class="list-group-item-text">Specially formatted on the script page. All values shown in reverse order. If absent MIT License (Expat) is implied. See <a href="/about/Terms-of-Service#licensing">licensing terms</a> for specifics.</p>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-userscript-block" href="#collapse-homepageurl"><code>@homepageURL url</code></a>
</h5>
</div>
<div id="collapse-homepageurl" class="panel-collapse collapse">
<div class="panel-body">A url of http, https or mailto protocol. Specially formatted on the script page. All values shown in reverse order.</div>
</div>
</div>
<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@homepageURL url</code></h5>
<p class="list-group-item-text">A url of http, https or mailto protocol. Specially formatted on the script page. All values shown in reverse order.</p>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-userscript-block" href="#collapse-supporturl"><code>@supportURL url</code></a>
</h5>
</div>
<div id="collapse-supporturl" class="panel-collapse collapse">
<div class="panel-body">A url of http, https or mailto protocol. Specially formatted on the script page. Last value shown.</div>
</div>
</div>
<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@supportURL url</code></h5>
<p class="list-group-item-text">A url of http, https or mailto protocol. Specially formatted on the script page. Last value shown.</p>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-userscript-block" href="#collapse-version"><code>@version 1.0.0</code></a>
</h5>
</div>
<div id="collapse-version" class="panel-collapse collapse">
<div class="panel-body">Enables automatic script updates in a .user.js engine. Usually major dot minor dot build <em>(or Patch)</em>. May utilize the <a href="https://developer.mozilla.org/docs/Toolkit_version_format">Toolkit version format</a> or <a href="http://semver.org/">Semantic Versioning <em>(SemVer)</em></a>. Last value shown.</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-userscript-block" href="#collapse-updateurl"><code>@updateURL https://openuserjs.org/meta/{{#authedUser}}{{authedUser.name}}{{/authedUser}}{{^authedUser}}username{{/authedUser}}/My_Script.meta.js</code></a>
</h5>
</div>
<div id="collapse-updateurl" class="panel-collapse collapse in">
<div class="panel-body"><strong>Required in lockdown mode.</strong> See <a href="/about/Frequently-Asked-Questions#q-does-openuserjs-org-have-meta-">this FAQ item</a> for more. Last value is used.</div>
</div>
</div>
</div>
<h3>OpenUserJS Block</h3>
<div class="list-group script-metadata-definitions">
<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@author {{#authedUser}}{{authedUser.name}}{{/authedUser}}{{^authedUser}}username{{/authedUser}}</code></h5>
<p class="list-group-item-text">The author of the script. Required to enable <a href="#collaboration">Collaboration</a>. Last value shown.</p>
<div class="panel-group" id="accordion-openuserjs-block">
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-openuserjs-block" href="#collapse-oujs-author"><code>@author {{#authedUser}}{{authedUser.name}}{{/authedUser}}{{^authedUser}}username{{/authedUser}}</code></a>
</h5>
</div>
<div id="collapse-oujs-author" class="panel-collapse collapse in">
<div class="panel-body">The author of the script. Required to enable <a href="#collaboration">Collaboration</a>. Last value shown.</div>
</div>
</div>
<div class="list-group-item">
<h5 class="list-group-item-heading"><code>@collaborator username</code></h5>
<p class="list-group-item-text">May be defined multiple times. Required for <a href="#collaboration">Collaboration</a>. All values shown in reverse order.</p>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">
<a data-toggle="collapse" data-parent="#accordion-openuserjs-block" href="#collapse-oujs-collaboration"><code>@collaborator username</code></a>
</h5>
</div>
<div id="collapse-oujs-collaboration" class="panel-collapse collapse">
<div class="panel-body">May be defined multiple times. Required for <a href="#collaboration">Collaboration</a>. All values shown in reverse order.</div>
</div>
</div>
</div>
{{/newUserJS}}
Expand Down
2 changes: 1 addition & 1 deletion views/pages/scriptPage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
{{#script.support}}<p><i class="fa fa-fw fa-support"></i> <b>Support:</b> <a href="{{{url}}}"{{#hasNoFollow}} rel="nofollow"{{/hasNoFollow}}>{{text}}</a></p>{{/script.support}}
{{#script.copyrights}}<p><i class="fa fa-fw fa-copyright"></i> <b>Copyright:</b> {{name}}</p>{{/script.copyrights}}
{{#script.licenses}}<p><i class="fa fa-fw fa-balance-scale"></i> <b>License:</b> {{name}}</p>{{/script.licenses}}
{{^script.isLib}}{{^script.licenses}}<p><i class="fa fa-fw fa-legal"></i> <b>License:</b> MIT License (Expat)</p>{{/script.licenses}}{{/script.isLib}}
{{^script.isLib}}{{^script.licenses}}<p><i class="fa fa-fw fa-legal"></i> <b>License:</b> <a href="https://spdx.org/licenses/MIT.html" title="SPDX Short id">MIT</a>; <a href="https://opensource.org/licenses/MIT" title="OSI and TOS Approved">https://opensource.org/licenses/MIT</a></p>{{/script.licenses}}{{/script.isLib}}
{{#hasCollab}}
<p><i class="fa fa-fw fa-user"></i> <b>Collaborator:</b> {{#script.collaborators}} <span class="label label-info"><a href="/users/{{{url}}}">{{text}}</a></span> {{/script.collaborators}}</p>
{{/hasCollab}}
Expand Down

0 comments on commit ad12cc0

Please sign in to comment.