DIY Disclosure files - Revision history

CarstenEmde: Added on-demand display of options of the SPDX2Disclosure script (design and features)

2024-09-19T21:41:18Z

Added on-demand display of options of the SPDX2Disclosure script (design and features)

@@ Line 2: / Line 2: @@
 =Create individually do-it-yourself designed disclosure files=
 This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.
 ==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==
 <html>
-<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" />
+<input type="button" onclick="showorhide(this, 'showtechbg');" value="Show technical background of this functionality" />
-<div id="showondemand" style="display: none;">
+<div id="showtechbg" style="display: none;">
 </html>
 The actual converter to create individually designed disclosure documents from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Github repository files is located on the www.osselot.org server and invoked via the PHP script "diydisclosure.php" with package name and version, page style and options given as query string. It can be called from browser or from command line using a shell script.

Wiki at 12:56, 9 March 2024

2024-03-09T12:56:19Z

← Older revision		Revision as of 14:56, 9 March 2024
Line 35:		Line 35:
	</script>		</script>
	</html>		</html>
	==Web interface to immediately use the above described script and [[Search\|search]] for a ~~given~~ package to create a disclosure document according to the given settings==		==Web interface to immediately use the above described script and [[Search\|search]] for a particular package to create a disclosure document according to the given settings==
	<html>		<html>
	<h5>Overall design</h5>		<h5>Overall design</h5>

CarstenEmde: Updated OSSelot logo to new font feature

2023-11-01T14:46:58Z

Updated OSSelot logo to new font feature

← Older revision		Revision as of 16:46, 1 November 2023
Line 7:		Line 7:
	<div id="showondemand" style="display: none;">		<div id="showondemand" style="display: none;">
	</html>		</html>
	The actual converter to create individually designed disclosure documents from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github repository files is located on the www.osselot.org server and invoked via the PHP script "diydisclosure.php" with package name and version, page style and options given as query string. It can be called from browser or from command line using a shell script.		The actual converter to create individually designed disclosure documents from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> Github repository files is located on the www.osselot.org server and invoked via the PHP script "diydisclosure.php" with package name and version, page style and options given as query string. It can be called from browser or from command line using a shell script.
	===Call from browser===		===Call from browser===
	The calling convention of the URL is		The calling convention of the URL is
Line 13:		Line 13:
	where <design> and <features> may be any of the related command line options of the Python script [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure]. For example, to retrieve a disclosure document of the "angular" package in version 15.2.2 with copyright notices and license references by file followed by a list with all referenced licenses (option "-lr") and prepended package information (option "-p") the URL [https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p] may be used.		where <design> and <features> may be any of the related command line options of the Python script [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure]. For example, to retrieve a disclosure document of the "angular" package in version 15.2.2 with copyright notices and license references by file followed by a list with all referenced licenses (option "-lr") and prepended package information (option "-p") the URL [https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p] may be used.
	===Call from command line===		===Call from command line===
	To create disclosure documents from arbitrary curated <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> packages with individually selected document format and features the following shell script can be used:		To create disclosure documents from arbitrary curated <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> packages with individually selected document format and features the following shell script can be used:
	#!/bin/bash		#!/bin/bash

Line 57:		Line 57:
	<input type="checkbox" id="preamble" name="preamble">		<input type="checkbox" id="preamble" name="preamble">
	<label for="preamble"> Prepend package information</label><br>		<label for="preamble"> Prepend package information</label><br>
	<h4>Look for software packages that may have already been curated at <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> and provide links to the related individually designed disclosure documents that will be created on the fly</h4>		<h4>Look for software packages that may have already been curated at <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> and provide links to the related individually designed disclosure documents that will be created on the fly</h4>
	<input type="text" onkeyup="searchtextkeyup(event, this, 'diydisclosure');" size="30"><button onclick="searchOSSelot(this, 'diydisclosure');">Search for an <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> disclosure document</button><br />		<input type="text" onkeyup="searchtextkeyup(event, this, 'diydisclosure');" size="30"><button onclick="searchOSSelot(this, 'diydisclosure');">Search for an <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">OSSelot</span> disclosure document</button><br />
	<span style="display: none;"></span>		<span style="display: none;"></span>
	<br />		<br />

Wiki: The updated "-c" option of the converter only enables SHA256 checksums

2023-10-24T04:40:07Z

The updated "-c" option of the converter only enables SHA256 checksums

← Older revision		Revision as of 06:40, 24 October 2023
Line 52:		Line 52:
	<h5>Additional features</h5>		<h5>Additional features</h5>
	<input type="checkbox" id="checksums" name="checksums">		<input type="checkbox" id="checksums" name="checksums">
	<label for="checksums"> Include ~~file~~ checksums</label><br>		<label for="checksums"> Include SHA256 checksums</label><br>
	<input type="checkbox" id="numbered" name="numbered">		<input type="checkbox" id="numbered" name="numbered">
	<label for="numbered"> Number files consecutively</label><br>		<label for="numbered"> Number files consecutively</label><br>

Wiki at 13:08, 8 October 2023

2023-10-08T13:08:01Z

← Older revision		Revision as of 15:08, 8 October 2023
Line 45:		Line 45:
	<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br>		<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br>
	<input type="radio" id="bsdtext" name="licensing" value="-lb">		<input type="radio" id="bsdtext" name="licensing" value="-lb">
	<label for="bsdtext"> Referenced license templates, then copyright notices and ~~licenses~~ by file with verbatim texts of non-template BSD-type licenses</label><br>		<label for="bsdtext"> Referenced license templates, then copyright notices and license references by file with verbatim texts of non-template BSD-type licenses</label><br>
	<input type="radio" id="hashedtext" name="licensing" value="-lh">		<input type="radio" id="hashedtext" name="licensing" value="-lh">
	<label for="hashedtext"> Referenced license templates, then copyright notices and ~~licenses~~ by file with verbatim texts of all non-template licenses</label><br>		<label for="hashedtext"> Referenced license templates, then copyright notices and license references by file with verbatim texts of all non-template licenses</label><br>
	<input type="radio" id="text" name="licensing" value="-lt">		<input type="radio" id="text" name="licensing" value="-lt">
	<label for="text"> Copyright notices and verbatim license texts by file</label><br>		<label for="text"> Copyright notices and verbatim license texts by file</label><br>

Wiki at 12:58, 8 October 2023

2023-10-08T12:58:45Z

← Older revision		Revision as of 14:58, 8 October 2023
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	=Create individually designed disclosure files=		=Create individually do-it-yourself designed disclosure files=
	This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.		This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.
	==Encapsulate the [[Search\|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==		==Encapsulate the [[Search\|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files==

Wiki: Added NOTOC

2023-10-08T12:51:54Z

Added __NOTOC__

← Older revision		Revision as of 14:51, 8 October 2023
Line 1:		Line 1:
			__NOTOC__
	=Create individually designed disclosure files=		=Create individually designed disclosure files=
	This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.		This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository.

Wiki: Tried to improve some radio button labels and extended the explanation of access via browser

2023-10-08T12:47:58Z

Tried to improve some radio button labels and extended the explanation of access via browser

← Older revision		Revision as of 14:47, 8 October 2023
Line 8:		Line 8:
	The actual converter to create individually designed disclosure documents from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github repository files is located on the www.osselot.org server and invoked via the PHP script "diydisclosure.php" with package name and version, page style and options given as query string. It can be called from browser or from command line using a shell script.		The actual converter to create individually designed disclosure documents from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github repository files is located on the www.osselot.org server and invoked via the PHP script "diydisclosure.php" with package name and version, page style and options given as query string. It can be called from browser or from command line using a shell script.
	===Call from browser===		===Call from browser===
	~~This~~ example ~~retrieves the data~~ of the "angular" package in version 15.2.2 ~~and creates a disclosure document~~ with copyright notices ~~per~~ file ~~plus~~ all licenses ~~referenced~~ (option "-lr") and prepended package information (option "-p")~~. The related~~ URL is [https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p].		The calling convention of the URL is
			<nowiki>https://www.osselot.org/diydisclosure.php?<package>/version-<version>&<design>&<features></nowiki>
			where <design> and <features> may be any of the related command line options of the Python script [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure]. For example, to retrieve a disclosure document of the "angular" package in version 15.2.2 with copyright notices and license references by file followed by a list with all referenced licenses (option "-lr") and prepended package information (option "-p") the URL [https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p https://www.osselot.org/diydisclosure.php?angular/version-15.2.2&-lr&-p] may be used.
	===Call from command line===		===Call from command line===
	To create disclosure documents from arbitrary curated <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> packages with individually selected document format and features the following shell script can be used:		To create disclosure documents from arbitrary curated <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> packages with individually selected document format and features the following shell script can be used:
Line 42:		Line 44:
	<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br>		<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br>
	<input type="radio" id="bsdtext" name="licensing" value="-lb">		<input type="radio" id="bsdtext" name="licensing" value="-lb">
	<label for="bsdtext"> ~~Unreferenced licenses~~, then copyright notices and licenses by file, verbatim texts of non-template BSD-type licenses</label><br>		<label for="bsdtext"> Referenced license templates, then copyright notices and licenses by file with verbatim texts of non-template BSD-type licenses</label><br>
	<input type="radio" id="hashedtext" name="licensing" value="-lh">		<input type="radio" id="hashedtext" name="licensing" value="-lh">
	<label for="hashedtext"> ~~Unreferenced licenses~~, then copyright notices and licenses by file, verbatim texts of all non-template licenses</label><br>		<label for="hashedtext"> Referenced license templates, then copyright notices and licenses by file with verbatim texts of all non-template licenses</label><br>
	<input type="radio" id="text" name="licensing" value="-lt">		<input type="radio" id="text" name="licensing" value="-lt">
	<label for="text"> ~~Unreferenced licenses, then copyright~~ notices and verbatim license texts by file</label><br>		<label for="text"> Copyright notices and verbatim license texts by file</label><br>
	<h5>Additional features</h5>		<h5>Additional features</h5>
	<input type="checkbox" id="checksums" name="checksums">		<input type="checkbox" id="checksums" name="checksums">

Wiki: Improved description of document formats, added radio button to fall back to unmodified SPDX standard

2023-10-08T12:23:27Z

Improved description of document formats, added radio button to fall back to unmodified SPDX standard

← Older revision		Revision as of 14:23, 8 October 2023
Line 35:		Line 35:
	<html>		<html>
	<h5>Overall design</h5>		<h5>Overall design</h5>
	<input type="radio" id="~~none~~" name="licensing" ~~checked~~="~~checked~~" value="-ln">		<input type="radio" id="standard" name="licensing" value="standard">
	<label for="none"> ~~Additional section with~~ copyright notices ~~per~~ file</label><br>		<label for="none"> Unreferenced licenses, then copyright notices (unmodified SPDX standard)</label><br>
	<input type="radio" id="referenced" name="licensing" value="-lr">		<input type="radio" id="none" name="licensing" value="-ln">
	<label for="referenced"> ~~Same as first choice plus all~~ licenses ~~referenced~~</label><br>		<label for="none"> Unreferenced licenses, then copyright notices by file</label><br>
			<input type="radio" id="referenced" name="licensing" checked="checked" value="-lr">
			<label for="referenced"> Copyright notices and license references by file, then referenced licenses</label><br>
	<input type="radio" id="bsdtext" name="licensing" value="-lb">		<input type="radio" id="bsdtext" name="licensing" value="-lb">
	<label for="bsdtext"> ~~Same as first choice plus~~ non-~~standard~~ BSD licenses ~~verbatim~~</label><br>		<label for="bsdtext"> Unreferenced licenses, then copyright notices and licenses by file, verbatim texts of non-template BSD-type licenses</label><br>
	<input type="radio" id="hashedtext" name="licensing" value="-lh">		<input type="radio" id="hashedtext" name="licensing" value="-lh">
	<label for="hashedtext"> ~~Same as first choice plus~~ all ~~hashed~~ licenses ~~verbatim~~</label><br>		<label for="hashedtext"> Unreferenced licenses, then copyright notices and licenses by file, verbatim texts of all non-template licenses</label><br>
	<input type="radio" id="text" name="licensing" value="-lt">		<input type="radio" id="text" name="licensing" value="-lt">
	<label for="text"> ~~Same as first choice plus all~~ licenses verbatim</label><br>		<label for="text"> Unreferenced licenses, then copyright notices and verbatim license texts by file</label><br>
	<h5>Additional features</h5>		<h5>Additional features</h5>
	<input type="checkbox" id="checksums" name="checksums">		<input type="checkbox" id="checksums" name="checksums">

Wiki at 19:58, 7 October 2023

2023-10-07T19:58:20Z

← Older revision		Revision as of 21:58, 7 October 2023
Line 32:		Line 32:
	</script>		</script>
	</html>		</html>
	==Web interface to immediately use the above described script and [[Search\|search]] for a given package ~~and~~ create a disclosure document according to the given settings==		==Web interface to immediately use the above described script and [[Search\|search]] for a given package to create a disclosure document according to the given settings==
	<html>		<html>
	<h5>Overall design</h5>		<h5>Overall design</h5>