Skip to content

refactored code to align with vocab markup for person #865

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jan 7, 2025
Merged

refactored code to align with vocab markup for person #865

merged 4 commits into from
Jan 7, 2025

Conversation

Queen-codes
Copy link
Contributor

Fixes

Description

This PR refactors the author.html code to match the specimen provided for person-page.html in vocabulary

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin 
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Queen-codes Queen-codes requested review from a team as code owners December 24, 2024 06:30
@Queen-codes Queen-codes requested review from TimidRobot, Shafiya-Heena and dhruvkb and removed request for a team December 24, 2024 06:30
@TimidRobot TimidRobot self-assigned this Dec 27, 2024
TimidRobot
TimidRobot requested changes Dec 27, 2024
View reviewed changes
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please merge the updated vocab-refresh branch in.

Also, you should be able to get it to look better under Vocabulary (for example, see https://creativecommons.org/person/monicacreativecommons-org/)

@TimidRobot TimidRobot changed the title refacored code to align with vocab markup for person refactored code to align with vocab markup for person Dec 27, 2024
@Queen-codes
Copy link
Contributor Author

Please merge the updated vocab-refresh branch in.

Also, you should be able to get it to look better under Vocabulary (for example, see https://creativecommons.org/person/monicacreativecommons-org/)

Hi @TimidRobot

I noticed that in Vocabulary, each page has a specific class on the body tag to apply styles for that page’s context. For example, in this instance, the class is person-page.

I added the class manually in layout.html and observed the following result:

Screenshot 2024-12-30 at 15 09 52

To make this dynamic (since each page may require different classes), the body tag in layout.html would need to render dynamically like this:

<body {% if this.body_class %}class="{{ this.body_class }}"{% endif %}>

Then, the respective model file (author.ini in this case) would need an update like this:

[fields.body_class] label = Body Class type = string default = "person-page"

Finally, the front matter for each page would need to define its specific body_class.

I haven’t implemented this yet because I thought the goal was to align the markup first and focus on styling later. However, I can go ahead and implement this now to ensure it works. Let me know if this is the right time to proceed. If there are other alternatives that could work, please share with me.

@TimidRobot
Copy link
Member

[...] To make this dynamic (since each page may require different classes), the body tag in layout.html would need to render dynamically [...]

@Queen-codes This looks like a good solution--I think this is worthwhile to do now

@TimidRobot TimidRobot mentioned this pull request Jan 6, 2025
Merged
7 tasks
@Queen-codes Queen-codes requested a review from TimidRobot January 7, 2025 13:45
TimidRobot
TimidRobot approved these changes Jan 7, 2025
View reviewed changes
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good work, thank you!

@TimidRobot TimidRobot merged commit 6d82a67 into creativecommons:vocab-refresh Jan 7, 2025
1 check passed
@Queen-codes Queen-codes deleted the author-page-refactor branch January 11, 2025 10:04
@Queen-codes Queen-codes mentioned this pull request Jan 24, 2025
Open
70 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TimidRobot TimidRobot TimidRobot approved these changes

@Shafiya-Heena Shafiya-Heena Awaiting requested review from Shafiya-Heena Shafiya-Heena is a code owner automatically assigned from creativecommons/technology

@dhruvkb dhruvkb Awaiting requested review from dhruvkb dhruvkb is a code owner automatically assigned from creativecommons/ct-cc-open-source-core-committers

Assignees

@TimidRobot TimidRobot

Labels
None yet
Projects
TimidRobot
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Queen-codes @TimidRobot