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

Adds summary field to data model and templates #211

Closed
wants to merge 19 commits into from

Conversation

kiyose
Copy link
Contributor

@kiyose kiyose commented Nov 16, 2024

This fixes issue #210 by adding a summary field to entry types.

For example:

projects:
      - name: Multi-User Drawing Tool
        summary:
          - The Multi-User Drawing Tool has been released to tens of users saving thousands of microseconds worth of effort.
        highlights:
          - Developed an electronic classroom where multiple users
            can simultaneously view and draw on a "chalkboard"

The only change in functionality is in the data model here rendercv/data/models/entry_types.py. The rest of the files are updating the templates and tests.

@sinaatalay
Copy link
Collaborator

Could you please provide the screenshots of what summary key creates exactly?

@sinaatalay sinaatalay marked this pull request as draft November 17, 2024 23:13
@kiyose
Copy link
Contributor Author

kiyose commented Nov 18, 2024

Here are two entries before from before this PR.
without_summary

and here are the same entries after adding the summary.
with_summary

@dyliu0312
Copy link

Thank you, guys.
This is exactly the kind of functionality I was hoping for, as long as it also works in the Publication section

@sinaatalay
Copy link
Collaborator

Thank you for the pull request!

I think it would be the best to not merge this.

We are planning to transition to Typst soon, and each design update like this increases the complexity of maintenance. We need to ensure that design (LaTeX templates) works as expected with various combinations of design settings, which requires extensive manual testing. Currently, RenderCV runs robustly with its LaTeX templates, and we wouldn't want to break it right before we switch to Typst. Typst will require a lot of work. We can implement these in Typst.

For those interested in using these keys in RenderCV:

It is already quite simple to do so. That's why we allow users to use arbitrary keys in their YAML files and override the default LaTeX templates. Check out the links for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants