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

Added license URI to orignal author #51

Merged
merged 11 commits into from Aug 15, 2019

Conversation

@VincentTam
Copy link
Collaborator

commented Aug 12, 2019

Description

  • Added proper attribution to the original author in the README, LICENSE, and the site footer so that on every page generated by this theme, there'll be proper attribution to the original author.
  • Changed the text width of README to 80.
  • Removed the carriage return \r in the :br: Brazillian Portuguese locale.
  • Added {{ .Site.Hugo.version }} for displaying the version number of Hugo during site compilation. This helps us understand which Hugo version the user is using in case (s)he opens an issue here.
  • Fixed some typo in README.
    • I prefered splitting "HTML5 UP" into two words instead of "HTML5UP". That's what can be seen on the original author's website: https://aj.lkn.io/
    • I've put "CSS Grid" instead of "CSS-Gridd" based on DuckDuckGo's search results.

Motivation and Context

Resolve @balibebas's follow-up comment in #47, and introduce a link "Hugo v0.xx.x" displaying the actual version of Hugo used by the site owner. This might facilitate our debugging process.

Screenshots (if appropriate):

Screenshot_2019-08-12 Hugo Future Imperfect Slim in fr

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

Reference

  1. Full text of CC BY 3.0 License

    \4. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

    (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing entity, journal) for attribution ("Attribution Parties") in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties;

    I prefer using "@ajlkn' instead of "HTML5 UP" for this attribution since the former sounds like a human user, whereas the later sounds like an orgainisation.

  2. How to give attribution - Creative Commons

VincentTam added some commits Aug 11, 2019

Added proper attribution in README
Also fixed some typos and used textwidth = 80 without breaking Markdown links
Added CC BY 3.0 and Hugo version used to footer
The former addresses
#47 (comment).
The later helps debugging.  Also removed carriage return from 'i18n/br.toml'.
@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 12, 2019

See comments on #47 on what we should do here. No where in the license does it demand that there be a direct link on each web page to his site. The work just has to give equal attribution, which it does everywhere else (if not more than enough). If he wants it on every page, it can be a comment at the top of the HTML. It does not need to be visible, unless he can show where in the license it is required to be on every page.

i18n/en.toml Outdated Show resolved Hide resolved
LICENSE.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@pacollins
Copy link
Owner

left a comment

For the rest of the i18n, see the comments on the English one.

@VincentTam VincentTam changed the title Added attribution to orignal author at the footer. Added license URI to orignal author Aug 12, 2019

@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 13, 2019

I don't love how the Copyright block looks right now. There are so many words because "Future Imperfect" and "Hugo Future Imperfect Slim" are so long. I like everything else. I'm not quite sure what the fix is.

Not to prolong the change or be a pain, but it is kinda an eyesore at the moment (and I realize the current version was my suggestion) that people will be wanting to remove anyway. If we want people to leave it alone, it has to look good.

@VincentTam

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 14, 2019

I don't love how the Copyright block looks right now. There are so many words because "Future Imperfect" and "Hugo Future Imperfect Slim" are so long. I like everything else. I'm not quite sure what the fix is.

I share your view about the visual effect. That's why my demo site has the context root "fish-demo" instead of the name of this repo. But I've no idea what the site footer should be.

@VincentTam

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 14, 2019

My mind blocked me after a weekend's work on providing/improving nested Staticman comments support for Hugo Swift Theme, Introduction, Huginn, and my blog using Beautiful Hugo.

I've got the inspiration from Hugo Swift Theme to suggest the following shortened footer:

Designed by @pacollins, ported from HTML5 UP O 3.0.

Screenshot_2019-08-14 Hugo Future Imperfect Slim
Desktop view
Screenshot_2019-08-14 Hugo Future Imperfect Slim(2)
Mobile view simulated from Firefox

The link text and link target are the author and the URL for the work. The former (author's name) is much the later (work's name). The license and its URI is condensed to the icon 'O' illustrating the Font Awesome icon for CC-BY, and a link is added to the URI of the human readable version of the license. In the the whole footer, there's only four English words to be translated: "designed by" and "ported from". I prefer keeping the current {{ i18n "attribution" }} since the word order (e.g. SVO, SOV) can be different in different languages. (e.g. "I see you." SVO 🇬🇧 -> "Je te vois." 🇫🇷)

@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 14, 2019

I like your solution. It has given me an idea:

<p class="copyright">
© 2019 Hugo Future Imperfect Slim<br>
Theme: <a href="https://github.com/pacollins/hugo-future-imperfect-slim">Hugo Future Imperfect Slim</a><br>
A <a href="https://html5up.net/future-imperfect">HTML5 UP port</a> | Powered by <a href="https://gohugo.io/">Hugo</a>
</p>

footer

footer2

  • It provides the user a full line for copyright information.
  • It creates a consistent three lines for all sizes.
  • It provides Hugo advertising.
  • It replaces my name with the theme name (because more than just me have contributed to the theme).

Thoughts? I'll be on for the next few hours, so no need to make a commit if you disagree or have other thoughts.

@VincentTam

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 14, 2019

Thoughts? I'll be on for the next few hours, so no need to make a commit if you disagree or have other thoughts.

Looking at the visual results for English, the difference between my solution and yours is like amateur vs professional. Wow! What an instant pleasure! 😀 ✌️

However, thinking about this in 🇫🇷 French, I've discovered the possibility that the "consistent three lines" becomes four lines.

Screenshot_2019-08-14 Hugo Future Imperfect Slim in fr

If you're OK about that, then I'll proceed to writing other translations.

@VincentTam

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 14, 2019

🇫🇷 The French way to use the word adapter (to adapt) is adapter qqch1 en qqch2 (to adapt into sth2 from sth1). Some modern developers might be confortable with "adapté de qqch1 en qqch2", but some Francophones (like me) would rather prefer "une adaptation de qqch1 en qqch2" (an adaptation from qqch1 to qqch2).

In the related discussion: https://forum.wordreference.com/threads/taken-and-adapted-from.2356960/ on Word Reference, Snarkhunter suggests using "sth like "transposer (à partir) (de / du)..."."

Applying his suggestion would give sth like

Screenshot_2019-08-14 Hugo Future Imperfect Slim in fr(1)

Btw, it's really hard to read the grave and acute accents in the footer.

@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 14, 2019

Does French not have a word similar to "port" that is shorter or would change the syntax?

@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 14, 2019

To clarify, I am fine with "Transpose" if you think it works and the lack of visible grave and accent is fine. The French version of the Wikipedia article about porting uses "portage"

@pacollins pacollins referenced this pull request Aug 14, 2019
3 of 7 tasks complete
@VincentTam

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 14, 2019

Does French not have a word similar to "port" that is shorter or would change the syntax?

I don't know any shorter noun for that. Probably a French won't (care to) know. "Une adaptation" is the best way to say that. I didn't see "transposé de" in this context before, but it's alright to use that. Many Francophones are going to understand this. Given that the user who has suggested this is from Ile-de-France, I'm OK with this.

My concern is that the "consistent three lines for all sizes" might be broken into four lines when translated into other languages. After searching a French dictionary for that (probably non-existent word), we might run into this situation again in another language in the future. This approach would be succumb to imperfection in the future.

🇫🇷 In French, compound nouns are rare. Perhaps "assurance habition" (housing assurance) would be the only possible one that I know. (I've spent a few moment to search "le porte-parole": "la porte" (door) and "la parole" (speech), but the "porte" actually comes from the word "porter" (to wear, to uptake a role, etc)) In any case, if you search for a direct literal translation in French for "A HTML5 UP port", it would be in the form "un(e) xxx de HTML5 UP".


Edited: I've seen "le portage" after submitting this comment for the first time. Let's stick to this.

Screenshot_2019-08-15 Hugo Future Imperfect Slim in fr

@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 14, 2019

I think the best course of action is to encourage phrasing on to three lines, but not at the expense the translations integrity. That being said, go ahead and push the final commit. With your discretion, pick whichever phrasing translates best. If we have someone that comes along later with better phrasing, we can adjust it then.

"A HTML5 UP port"

I am glad you said that. I wrote "An HTML5 UP Port," but that is incorrect. "A HTML5 UP Port"

@VincentTam

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 14, 2019

Thanks for reminding me of "le portage". That's more specific and precise. Let's stick with this.

@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 14, 2019

For the license page, maybe we make it clear and model it after this license, which is also an HTML5 UP Port.

VincentTam added some commits Aug 15, 2019

Another template edit for getting three-line footer
All files good except Portuguese one.
@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 15, 2019

Going to hold for 30 minutes just to make sure you didn't have anything else. @VincentTam, if you read this message before then, feel free to squash and merge if you are ready.

@VincentTam

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 2019

The only issue is the Brazillian Portuguese translation. I don't know Portuguese, so I can't help on that.

Screenshot_2019-08-15 Hugo Future Imperfect Slim em português

"Le portage" refers to the act of porting rather than the object to be ported. In our case, our theme can represent the product as well as the process of porting, so I see no problem using "le portage" here, even though that's not a word-to-word translation.

@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 15, 2019

I am not sure who made the original Brazilian Portuguese, so I think it is fine. Hopefully, they will swing by and adjust it for their use.

@pacollins

This comment has been minimized.

Copy link
Owner

commented Aug 15, 2019

Based on my research, the proper is:

© 2019 Hugo Future Imperfect Slim
Tema: Hugo Future Imperfect Slim
Uma Porta HTML5 UP | Disponibilizado pelo Hugo

I am 100% sure on the "Powered by Hugo" the problem is that line is 3 characters two long. I think we can drop "Uma" without losing meaning and keep it on three lines. Worst case, someone comes in knowing Portuguese and corrects it for us. That would make it:

Tema: <a href='https://themes.gohugo.io/hugo-future-imperfect-slim/' target='_blank' rel='noopener'>Hugo Future Imperfect</a><br><a href='https://html5up.net/future-imperfect' target='_blank' rel='noopener'>Porta HTML5 UP</a> | Disponibilizado pelo <a href='https://gohugo.io/' title='{{ .Site.Hugo.Version }}' target='_blank' rel='noopener'>Hugo</a>

So I'd go change the Portuguese and then go ahead and merge.

Also, I don't mind title='{{ .Site.Hugo.Version }}, but it is actually in the header:

Don't feel obligated to remove it, because it will probably be a little more accessible than the other.

@VincentTam

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 15, 2019

Based on my research, the proper is:

© 2019 Hugo Future Imperfect Slim
Tema: Hugo Future Imperfect Slim
Uma Porta HTML5 UP | Disponibilizado pelo Hugo

I am 100% sure on the "Powered by Hugo" the problem is that line is 3 characters two long. I think we can drop "Uma" without losing meaning and keep it on three lines. Worst case, someone comes in knowing Portuguese and corrects it for us. That would make it:

Tema: <a href='https://themes.gohugo.io/hugo-future-imperfect-slim/' target='_blank' rel='noopener'>Hugo Future Imperfect</a><br><a href='https://html5up.net/future-imperfect' target='_blank' rel='noopener'>Porta HTML5 UP</a> | Disponibilizado pelo <a href='https://gohugo.io/' title='{{ .Site.Hugo.Version }}' target='_blank' rel='noopener'>Hugo</a>

Dropping "uma" doesn't change the meaning, and "disponibilizado pelo Hugo" seems to be a better choice. The only thing left is "porta". From Collins Portuguese Dictionary, it seems to be the Portugese word for "port" in computing, but "port" in computing has two meanings: the controller for connection with other machines; and the modified software from an existing one on other platform. Using Lexilogos, I've found a few Portugest–English dictionaries, like Michaelis, Word Reference and Wiktionary. Their translations under "computing" applies to the "port" as in "port number" or the gateway controlling incoming/outgoing data. That's why I've put "Adaptado de". Maybe a Spanish translation can shed us some light.

So I'd go change the Portuguese and then go ahead and merge.

Also, I don't mind title='{{ .Site.Hugo.Version }}, but it is actually in the header:

Don't feel obligated to remove it, because it will probably be a little more accessible than the other.

Thanks for pointing this line to me. If I had seen that, I wouldn't have put {{ .Site.Hugo.Version }} in the i18n files. However, I'll leave it there becaue of your feedback.

@pacollins pacollins merged commit 8616dfe into pacollins:master Aug 15, 2019

1 check passed

AccessLint Review complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.