-
Notifications
You must be signed in to change notification settings - Fork 327
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.
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
License Snippets Take 2 #3583
base: master
Are you sure you want to change the base?
License Snippets Take 2 #3583
Conversation
Reduce CC license to just the wording and badges needed to display Reduce the Orc license to just the Text needed to display
Add icons and inclusion text for Old School Essentials
Great list of content =) Please link the original issue and the previous PR. |
scratch the zero there (suggesting it's a variant on the public domain, which is nonsensical), and swap the NC and SA
Also linking the tags droplist schema which can be updated I have updated the schema there with the following: <datalist id="tags-list">
<option value="license:AELF">AELF</option>
<option value="license:Blades in the Dark</option>
<option value="license:CC0">Creative Commons Public Domain</option>
<option value="license:CC BY-SA">Creative Commons Attribution, Share Alike</option>
<option value="license:CC BY-NC">Creative Commons Attribution, Non Commercial</option>
<option value="license:CC BY-NC-SA">Creative Commons Attribution, Non Commercial, Share Alike</option>
<option value="license:CC BY-ND">Creative Commons Attribution, No Derivatives</option>
<option value="license:CC BY-NC-ND">Creative Commons Attribution, Non Commercial, No Derivatives</option>
<option value="license:GNU FDL">GNU Free Documentation License</option>
<option value="license:GNU GPLv3">"</option>
<option value="license:MIT License"></option>
<option value="license:OGL 1.0a"></option>
<option value="license:OGL">Open Gaming License</option>
<option value="license:OSE 3PL">Old School Essentials</option>
<option value="license:ORC 1.0">"</option>
<option value="license:PD">Public Domain</option>
<option value="license:Shadowdark"></option>
<option value="license:WotC FCP">Fan Content Policy</option>
</datalist> |
Will also close #1976 [Snippet] OGL License Text Another related issue is #723, which could be closed by adding an extra menu item to the license snippet menu .. one that does not insert a license, but instead links to a homebrewery page with licensing faqs. Make the menu item look like a link (e.g. blue underline), and attach a "link" icon (e.g. 🔗 or fa-arrow-up-right-from-square) |
Cut and paste error building the list in the PR description. The code is correct.
This is how they are currently listed on the CC site. https://creativecommons.org/share-your-work/cclicenses/ I haven't been a deep follower of the CC changes over the years, I don't know if this is a change from earlier versions of the CC. |
I've not kept close eye either .. fair enough, I guess they figure it's implied. |
I disagree with this. It would be really weird to have a link, even visually distinguished from snippets, in the snippet bar. No one is looking for it there, and no one would know why suddenly it is there. If anything, it's better to put in the "account" dropdown menu as a separate page-- but I think having a md file in the repo with the info is "good enough", linked from the readme and the default "/new/" page. |
Providing help or additional information in the situation of where the user might now have additional questions (likely prompted by their cursory consideration of visible options) is hardly weird. It's called providing contextual help. Not weird at all. Good UX supports multiple modalities of information provision.
|
I suspect contextual help would be better as a popover Dialog item at the time of snippet insertion; it would be strange if it was out of the normal snippet insertion workflow. However, this has never been done before, so creation of such a system is out of scope for this PR. |
… pile. I skipped anything that didn't have an obvious license boilerplate in their "How To" and will revist those once these are all cleared and validated with their publishers.
Overflows the frame. Needs reordered on the menu. Some labels need improved.
Right, though I would put it in the same "help" bar as the FAQ and Migrate pages. A cooking website with a list of recipes might have a FAQ page. But it would be weird to bury the FAQ page as an ingredient in the recipe, or as a recipe called "FAQ". Makes way more sense to me to put it in a consistent location alongside other "resource" pages. Its also possible we are picturing different things. Some snippets do inject comments because they aren't intuitive on their own, so its not unreasonable that some kind of helper tool could be added at some point. But in any case, G-Ambatte is right that this would belong in a separate PR and probably needs discussion in its own issue. |
An additional bit of help here may be to pick a better menu label for this category. |
If it is of interest, DMs Guild license blurb is here under DMsGuild License and Legal Text: https://help.dmsguild.com/hc/en-us/articles/12776887523479-Dungeon-Masters-Guild-Licensing-Information It also needs the DMs Guild logo on the cover. |
Is it just me or are these... a little too many options? |
👎 on a interruptive popover dialog on snippet insertion, especially if modal (vs. eg. toasty). That would get old very fast for some snippets, plus it only reveals itself after committing to inserting the snippet (which is the moment of greatest doubt and hence need for clarification). Slightly better is how some snippets insert html or css comments (and thus don't interrupt flow, can be easily ignored), though still only revealing itself all too late. This is what I had in mind, possibly with some subtle styling for differentiation (i.e. not just the icon) Selecting that could trigger a popover modal dialog with the key info (and button to close/dismiss, and maybe button(s) or links that open to a FAQ/Help/Resource page as needed.
Agreed, it needs a separate Issue for isolation & consideration. I see @calculuschild already logged a very similar idea at #3612. Tagging here to close the loop. |
It's a big target list, yes. Given we're under 50% on positive responses right now, I'm not too worried - though we ABSOLUTELY have issues with the current snippet code this exposes. |
This is an extension and small rework of the original License snippets PR #3090.
This creates a new editor menu with entries for each License Entity containing compatibility logos and license-required inclusion. A sub-menu is used for the category when there is more than one option ( Creative Commons -> Badges -> CC0 Badge ) unless only logos or text exist.
Some consistency tightening is needed, you'll note that the labels for the submenus vary. Looking for opinions on which is most clear.
This PR includes snippets to insert:
To Do: