diff --git a/docs/src/guide/index.md b/docs/src/guide/index.md index 00fcae35b7..a74c55e016 100644 --- a/docs/src/guide/index.md +++ b/docs/src/guide/index.md @@ -425,14 +425,14 @@ tests, as well as a file named `suite.json` describing which files to test. Should have the same folder structure as the `src` directory; see the section on automated testing for more information. -For example, the directory structure for bundle `platform/commonUI/about` looks +For example, the directory structure for bundle `platform/commonUI/dialog` looks like: Platform | |-commonUI | - +-about + +-dialog | |-res | diff --git a/platform/commonUI/about/README.md b/platform/commonUI/about/README.md deleted file mode 100644 index 05bcfe22cd..0000000000 --- a/platform/commonUI/about/README.md +++ /dev/null @@ -1,26 +0,0 @@ -The "about" bundle provides the default lower-right application logo, -as well as the dialog it launches when clicked. - -# Extensions - -The About dialog contains several line items to display different -version properties (e.g. when built, et cetera.) Plug-ins may wish -to introduce additional line items here, in particular if the -platform is used to build a separately-branded piece of software. - -This bundle introduces the `versions` extension category to support this. -An extension of this category is implementation-less (all information -is contained within its declaration) and should include the following -fields: - -* `name`: The name to display for this version line-item; this may - be the name of the software, or something else such as "Built". -* `value`: The value to display corresponding to this line-item; - this is typically a version number, revision identifier, or - human-readable date. -* `description`: Optional; a longer-form description of this line - item, to display in a tooltip. - -Ordering of these line items is handled by extension priority; see framework -documentation (`platform/framework/README.md`) for information on how -this ordering is handled. diff --git a/platform/commonUI/about/bundle.js b/platform/commonUI/about/bundle.js deleted file mode 100644 index efa8a7c4d3..0000000000 --- a/platform/commonUI/about/bundle.js +++ /dev/null @@ -1,181 +0,0 @@ -/***************************************************************************** - * Open MCT, Copyright (c) 2014-2021, United States Government - * as represented by the Administrator of the National Aeronautics and Space - * Administration. All rights reserved. - * - * Open MCT is licensed under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * http://www.apache.org/licenses/LICENSE-2.0. - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations - * under the License. - * - * Open MCT includes source code licensed under additional open source - * licenses. See the Open Source Licenses file (LICENSES.md) included with - * this source code distribution or the Licensing information page available - * at runtime from the About dialog for additional information. - *****************************************************************************/ - -define([ - "./res/templates/about-dialog.html", - "./src/LogoController", - "./src/AboutController", - "./src/LicenseController", - "./res/templates/app-logo.html", - "./res/templates/about-logo.html", - "./res/templates/overlay-about.html", - "./res/templates/license-apache.html", - "./res/templates/license-mit.html", - "./res/templates/licenses.html", - "./res/templates/licenses-export-md.html" -], function ( - aboutDialogTemplate, - LogoController, - AboutController, - LicenseController, - appLogoTemplate, - aboutLogoTemplate, - overlayAboutTemplate, - licenseApacheTemplate, - licenseMitTemplate, - licensesTemplate, - licensesExportMdTemplate -) { - - return { - name: "platform/commonUI/about", - definition: { - "name": "About Open MCT", - "extensions": { - "templates": [ - { - "key": "app-logo", - "priority": "optional", - "template": appLogoTemplate - }, - { - "key": "about-logo", - "priority": "preferred", - "template": aboutLogoTemplate - }, - { - "key": "about-dialog", - "template": aboutDialogTemplate - }, - { - "key": "overlay-about", - "template": overlayAboutTemplate - }, - { - "key": "license-apache", - "template": licenseApacheTemplate - }, - { - "key": "license-mit", - "template": licenseMitTemplate - } - ], - "controllers": [ - { - "key": "LogoController", - "depends": [ - "overlayService" - ], - "implementation": LogoController - }, - { - "key": "AboutController", - "depends": [ - "versions[]", - "$window" - ], - "implementation": AboutController - }, - { - "key": "LicenseController", - "depends": [ - "licenses[]" - ], - "implementation": LicenseController - } - ], - "licenses": [ - { - "name": "Json.NET", - "version": "6.0.8", - "author": "Newtonsoft", - "description": "JSON serialization/deserialization", - "website": "http://www.newtonsoft.com/json", - "copyright": "Copyright (c) 2007 James Newton-King", - "license": "license-mit", - "link": "https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md" - }, - { - "name": "Nancy", - "version": "0.23.2", - "author": "Andreas Håkansson, Steven Robbins and contributors", - "description": "Embedded web server", - "website": "http://nancyfx.org/", - "copyright": "Copyright © 2010 Andreas Håkansson, Steven Robbins and contributors", - "license": "license-mit", - "link": "http://www.opensource.org/licenses/mit-license.php" - }, - { - "name": "Nancy.Hosting.Self", - "version": "0.23.2", - "author": "Andreas Håkansson, Steven Robbins and contributors", - "description": "Embedded web server", - "website": "http://nancyfx.org/", - "copyright": "Copyright © 2010 Andreas Håkansson, Steven Robbins and contributors", - "license": "license-mit", - "link": "http://www.opensource.org/licenses/mit-license.php" - }, - { - "name": "SuperSocket", - "version": "0.9.0.2", - "author": " Kerry Jiang", - "description": "Supports SuperWebSocket", - "website": "https://supersocket.codeplex.com/", - "copyright": "Copyright 2010-2014 Kerry Jiang (kerry-jiang@hotmail.com)", - "license": "license-apache", - "link": "https://supersocket.codeplex.com/license" - }, - { - "name": "SuperWebSocket", - "version": "0.9.0.2", - "author": " Kerry Jiang", - "description": "WebSocket implementation for client-server communication", - "website": "https://superwebsocket.codeplex.com/", - "copyright": "Copyright 2010-2014 Kerry Jiang (kerry-jiang@hotmail.com)", - "license": "license-apache", - "link": "https://superwebsocket.codeplex.com/license" - }, - { - "name": "log4net", - "version": "2.0.3", - "author": "Apache Software Foundation", - "description": "Logging", - "website": "http://logging.apache.org/log4net/", - "copyright": "Copyright © 2004-2015 Apache Software Foundation.", - "license": "license-apache", - "link": "http://logging.apache.org/log4net/license.html" - } - ], - "routes": [ - { - "when": "/licenses", - "template": licensesTemplate - }, - { - "when": "/licenses-md", - "template": licensesExportMdTemplate - } - ] - } - } - }; -}); diff --git a/platform/commonUI/about/res/templates/about-dialog.html b/platform/commonUI/about/res/templates/about-dialog.html deleted file mode 100644 index 8b7cfe2204..0000000000 --- a/platform/commonUI/about/res/templates/about-dialog.html +++ /dev/null @@ -1,41 +0,0 @@ - -
Open MCT, Copyright © 2014-2021, United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All rights reserved.
-Open MCT is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-Open MCT includes source code licensed under additional open source licenses. See the Open Source Licenses file included with this distribution or click here for licensing information.
-Version 2.0, January 2004
-http://www.apache.org/licenses/
-"License" shall mean the terms and conditions for use, reproduction, and - distribution as defined by Sections 1 through 9 of this document.
-"Licensor" shall mean the copyright owner or entity authorized by the - copyright owner that is granting the License.
-"Legal Entity" shall mean the union of the acting entity and all other - entities that control, are controlled by, or are under common control with - that entity. For the purposes of this definition, "control" means (i) the - power, direct or indirect, to cause the direction or management of such - entity, whether by contract or otherwise, or (ii) ownership of fifty - percent (50%) or more of the outstanding shares, or (iii) beneficial - ownership of such entity.
-"You" (or "Your") shall mean an individual or Legal Entity exercising - permissions granted by this License.
-"Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation source, - and configuration files.
-"Object" form shall mean any form resulting from mechanical transformation - or translation of a Source form, including but not limited to compiled - object code, generated documentation, and conversions to other media types.
-"Work" shall mean the work of authorship, whether in Source or Object form, - made available under the License, as indicated by a copyright notice that - is included in or attached to the work (an example is provided in the - Appendix below).
-"Derivative Works" shall mean any work, whether in Source or Object form, - that is based on (or derived from) the Work and for which the editorial - revisions, annotations, elaborations, or other modifications represent, as - a whole, an original work of authorship. For the purposes of this License, - Derivative Works shall not include works that remain separable from, or - merely link (or bind by name) to the interfaces of, the Work and Derivative - Works thereof.
-"Contribution" shall mean any work of authorship, including the original - version of the Work and any modifications or additions to that Work or - Derivative Works thereof, that is intentionally submitted to Licensor for - inclusion in the Work by the copyright owner or by an individual or Legal - Entity authorized to submit on behalf of the copyright owner. For the - purposes of this definition, "submitted" means any form of electronic, - verbal, or written communication sent to the Licensor or its - representatives, including but not limited to communication on electronic - mailing lists, source code control systems, and issue tracking systems that - are managed by, or on behalf of, the Licensor for the purpose of discussing - and improving the Work, but excluding communication that is conspicuously - marked or otherwise designated in writing by the copyright owner as "Not a - Contribution."
-"Contributor" shall mean Licensor and any individual or Legal Entity on - behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work.
-2. Grant of Copyright License. Subject to the - terms and conditions of this License, each Contributor hereby grants to You - a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, publicly - display, publicly perform, sublicense, and distribute the Work and such - Derivative Works in Source or Object form.
-3. Grant of Patent License. Subject to the terms - and conditions of this License, each Contributor hereby grants to You a - perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, use, - offer to sell, sell, import, and otherwise transfer the Work, where such - license applies only to those patent claims licensable by such Contributor - that are necessarily infringed by their Contribution(s) alone or by - combination of their Contribution(s) with the Work to which such - Contribution(s) was submitted. If You institute patent litigation against - any entity (including a cross-claim or counterclaim in a lawsuit) alleging - that the Work or a Contribution incorporated within the Work constitutes - direct or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate as of the - date such litigation is filed.
-4. Redistribution. You may reproduce and - distribute copies of the Work or Derivative Works thereof in any medium, - with or without modifications, and in Source or Object form, provided that - You meet the following conditions:
-5. Submission of Contributions. Unless You - explicitly state otherwise, any Contribution intentionally submitted for - inclusion in the Work by You to the Licensor shall be under the terms and - conditions of this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify the - terms of any separate license agreement you may have executed with Licensor - regarding such Contributions.
-6. Trademarks. This License does not grant - permission to use the trade names, trademarks, service marks, or product - names of the Licensor, except as required for reasonable and customary use - in describing the origin of the Work and reproducing the content of the - NOTICE file.
-7. Disclaimer of Warranty. Unless required by - applicable law or agreed to in writing, Licensor provides the Work (and - each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, - without limitation, any warranties or conditions of TITLE, - NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You - are solely responsible for determining the appropriateness of using or - redistributing the Work and assume any risks associated with Your exercise - of permissions under this License.
-8. Limitation of Liability. In no event and - under no legal theory, whether in tort (including negligence), contract, or - otherwise, unless required by applicable law (such as deliberate and - grossly negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a result - of this License or out of the use or inability to use the Work (including - but not limited to damages for loss of goodwill, work stoppage, computer - failure or malfunction, or any and all other commercial damages or losses), - even if such Contributor has been advised of the possibility of such - damages.
-9. Accepting Warranty or Additional Liability. - While redistributing the Work or Derivative Works thereof, You may choose - to offer, and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this License. - However, in accepting such obligations, You may act only on Your own behalf - and on Your sole responsibility, not on behalf of any other Contributor, - and only if You agree to indemnify, defend, and hold each Contributor - harmless for any liability incurred by, or claims asserted against, such - Contributor by reason of your accepting any such warranty or additional - liability.
-To apply the Apache License to your work, attach the following boilerplate - notice, with the fields enclosed by brackets "[]" replaced with your own - identifying information. (Don't include the brackets!) The text should be - enclosed in the appropriate comment syntax for the file format. We also - recommend that a file or class name and description of purpose be included - on the same "printed page" as the copyright notice for easier - identification within third-party archives.
-Copyright [yyyy] [name of copyright owner] - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/platform/commonUI/about/res/templates/licenses-export-md.html b/platform/commonUI/about/res/templates/licenses-export-md.html deleted file mode 100644 index c83d7e2a44..0000000000 --- a/platform/commonUI/about/res/templates/licenses-export-md.html +++ /dev/null @@ -1,42 +0,0 @@ - -This software includes components released under the following licenses:
-### {{license.name}}
-#### Info
-* Link: {{license.website}}
-* Version: {{license.version}}
-* Authors: {{license.author}}
-* Description: {{license.description}}
-#### License
-{{license.copyright}}
--
---
-This software includes components released under the following licenses:
-- Version {{license.version}} - | Authors {{license.author}} - | Description {{license.description}} -
- License -{{license.copyright}}
-