Skip to content
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

Draft
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

dbolack-ab
Copy link
Collaborator

@dbolack-ab dbolack-ab commented Jul 18, 2024

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:

  • AELF - license
    • Contact
  • Blades in the Dark - logo, usage statement
    • Contact
  • Creative Commons CC0 - logo, usage statement
  • Creative Commons CC-BY - logo, usage statement
  • Creative Commons CC-BY-SA - logo, usage statement
  • Creative Commons CC-BY-NC-SA - logo, usage statement
  • Creative Commons CC-BY-ND - logo, usage statement
  • Creative Commons CC-BY-NC-ND - logo, usage statement
  • GNU FDL - License and both Title Page declarations
  • GNU GPLv3 - License and Title Page declaration
  • MIT License
  • ORC 1.0 - Notice
    • Contact - Does not seem to be needed
  • Old School Essentials - Logos and Declaration
    • Contact - Declined.
  • Shadowdark - Logos and License Statement
    • Contact - Approved
  • OGL 1.0a - License
  • WotC Fan Content Policy
  • DTRPG Community Content
    • Starforgers Guild
      • Contact
    • Holostreets
      • Contact
    • Hall of Champions
      • Contact - Does not seem to be needed
    • Genesys Foundry
      • Contact
    • Free League Workshop
      • Contact
    • Gallant Knight's Tiny Trove - Removed
      • Contact - Declined aggressively
    • Green Ronin's Age Creator's Alliance
      • Contact
    • Chronicle SystemGuild
      • Contact
    • Super-Powered by M&M
      • Contact
    • Grim and Perilous Library
      • Contact
    • Hero Kids Creator's Guild -
      • Contact
    • Travellers Aid Society - Will be revamping their program, asked to loop back at the first of the year.
      • Contact
    • Cypher System Creator
      • Contact
    • Canis Minor
      • Contact
    • Story Path Nexus
      • Contact
    • Disciples of the Demon Lord
      • Contact
    • City of Mists Garage
      • Contact
    • Epicismo Editions
      • Contact
    • Company of the Phoenix
    • DM's Guild
    • Scratchpad's Spectaculars
    • Icons
      • Contact

To Do:

  • Identify any RPGNow Partner programs that would be suitable additions
  • Identify any other OSR-styled products that might have their own licensing.
  • Pathfinder/Starfinder Infinite?

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
@ericscheid
Copy link
Collaborator

Great list of content =)

Please link the original issue and the previous PR.

@ericscheid
Copy link
Collaborator

ericscheid commented Jul 19, 2024

Creative Commons CC0-BY-NC-SA - logo, usage statement

scratch the zero there (suggesting it's a variant on the public domain, which is nonsensical), and swap the NC and SA

Creative Commons CC-BY-ND
Creative Commons CC-BY-NC-ND

these both need SA (else the NC ND content could be reshared with a different license)


Also linking the tags droplist schema which can be updated

#2335 (comment)

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>

@ericscheid
Copy link
Collaborator

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)

@dbolack-ab
Copy link
Collaborator Author

scratch the zero there (suggesting it's a variant on the public domain, which is nonsensical), and swap the NC and SA

Cut and paste error building the list in the PR description. The code is correct.

Creative Commons CC-BY-ND
Creative Commons CC-BY-NC-ND

these both need SA (else the NC ND content could be reshared with a different license)

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.

@ericscheid
Copy link
Collaborator

these both need SA (else the NC ND content could be reshared with a different license)

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.

@Gazook89
Copy link
Collaborator

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)

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.

@ericscheid
Copy link
Collaborator

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

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.

  • Directed seeking of information would be supported by having topical pages on the Need Help? menu (probably better than the Account page). We could even copy in the licensing info that is in the home page (and not currently in the FAQ).
  • Incidental queries would be supported by contextual "just in time" information like tool tips, links to help pages, etc. When someone is in the middle of a task, and they now have a question, the last thing they want to do is go off on a wild goose chase trying to find help.

@G-Ambatte
Copy link
Collaborator

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.
@dbolack-ab dbolack-ab marked this pull request as draft August 2, 2024 05:39
@calculuschild
Copy link
Member

calculuschild commented Aug 2, 2024

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

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.

@dbolack-ab
Copy link
Collaborator Author

An additional bit of help here may be to pick a better menu label for this category.

@RKuerten
Copy link
Collaborator

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.

@dbolack-ab dbolack-ab self-assigned this Sep 1, 2024
@5e-Cleric
Copy link
Member

Is it just me or are these... a little too many options?

@ericscheid
Copy link
Collaborator

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.

👎 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)

image

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.

However, this has never been done before, so creation of such a system is out of scope for this PR.

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.

@dbolack-ab
Copy link
Collaborator Author

Is it just me or are these... a little too many options?

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New Snippet Proposed new snippet, for any theme 🔍 R_ - Not ready for review 🕑
Projects
Status: Backlog
Development

Successfully merging this pull request may close these issues.

8 participants