Hi Daniel, Thanks Daniel. Agree with all below. Updated Wiki to reflect the changes. Details and additional response inline below.
Gary -----Original Message----- From: .dmg [mailto:[email protected]] On Behalf Of D M German Sent: Sunday, June 16, 2013 10:47 AM To: Gary O'Neall Cc: 'Jilayne Lovejoy'; [email protected] Subject: Re: none Gary O'Neall twisted the bytes to say: hi Gary, everybody, I looked at the proposal and I have few comments to finalize it: * Naming I would like to suggest that "parts" of the rule are renamed to be "fields" of rule: - A template is composed of text with rules embedded within it. - A rule is composed of fields (currently they are called parts) - A field is composed of a field name, semicolon, field value [Gary] I updated the text proposal to: 1.3 Template Format A template is composed of text with zero or more rules embedded in it. A rule is a variable section of a license wrapped between double curly braces "{{}}" and is composed of 5 fields. Each field is separated with a semi-colon ";". Rules cannot be embedded within other rules. * Double braces {{}} One problem I have run into is that {{}} are widely used by wikis and other HTML systems to escape a template of some sort. Try for example editing the following page and changing "{{}}" to "{{ and }}" http://wiki.spdx.org/view/Technical_Team/Proposals/2013-6-13/License_Templat e I have added the example at the bottom of the page. You will see how it is rendered because the wiki software has special interpretation for these fields. I ran into the same problem at github and even my own website software. This will make our editing of the rules in the wiki more difficult that they need to be. My suggestion is to replace the double braces with double angle brackets <<>> Again, this is simply stylistic and does not change anything. [Gary] Updated the proposal with <<>>. Originally, I was thinking we could use Mustache to implement the templates. The current proposal, however, will not work with the Mustache syntax so using the <<>> should work fine. In fact, using <<>> will allow future templates to include Mustache if we decide to have more information in the templates, so I am very much in favor of changing from {{}} to <<>>. Has there been any discussion on what variability will be allowed in the short term? Once that is decided, I can help with the creation of the templates. [Gary] I'll leave this to the legal team. I'll follow-up with you and Jilayne on a process proposal. Also, what is the master document? the Wiki or the Word document? [Gary] Let's use Wiki as the master since it is easier to edit. I included the word document as a convenience to Kate who would include this in the SPDX standard document PDF once finalized. Once it is included in the standard, the SPDX standard PDF document will become the master. --dmg Gary> As a follow-up to the last tech call, I just uploaded a proposal for text to Gary> include in the SPDX 1.2 standard for the license template format proposed by Gary> Daniel: Gary> http://wiki.spdx.org/view/Technical_Team/Proposals/2013-6-13/License_Templat Gary> e Gary> You may need to be logged into the wiki to see the word doc, so I'll also Gary> attach it to this email. Gary> Most of the proposal is a cut and paste from Danie'ls proposal at Gary> https://github.com/dmgerman/spdxTemplates Gary> I added a few details and clarification previously discussed or sent in Gary> emails and formatted it similar to the rest of the spec. Gary> Feel free to update the wiki if you have any corrections or changes. Gary> Let me know if you have any questions on the proposal. Gary> Gary Gary> ------------------------------------------------- Gary> Gary O'Neall Gary> Principal Consultant Gary> Source Auditor Inc. Gary> Mobile: 408.805.0586 Gary> Email: <mailto:[email protected]> [email protected] -- Daniel M. German "Never attribute to malice that which can be adequately Robert Heinlein -> explained by stupidity. " http://turingmachine.org/ http://silvernegative.com/ dmg (at) uvic (dot) ca replace (at) with @ and (dot) with . _______________________________________________ Spdx-tech mailing list [email protected] https://lists.spdx.org/mailman/listinfo/spdx-tech
