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

add peace-of-posters 0.4.0 #627

Merged
merged 3 commits into from
May 31, 2024
Merged

add peace-of-posters 0.4.0 #627

merged 3 commits into from
May 31, 2024

Conversation

jonaspleyer
Copy link
Contributor

I am submitting

  • a new package
  • an update for a package

Description:
This package/template allows users to create scientific posters with minimal additional syntax.
It also comes with extensive documentation.

This PR was previously closed due to inactivity: #379

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does
  • added a typst.toml file with all required keys
  • added a README.md with documentation for my package
  • have chosen a license and added a LICENSE file or linked one in my README.md
  • tested my package locally on my system and it worked
  • excluded PDFs or README images, if any, but not the LICENSE
  • ensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.

@elegaanz
Copy link
Contributor

Hi, and thanks for opening a new PR. There were a few points that were discussed in the previous one that would still need to be resolved:

  • first, it is still recommended to use kebab-case for public functions and their arguments. But this is only a recommendation to be more consistent with other packages, and you can keep snake_case if you prefer.
  • the package name is too canonical/obvious for what it does. Could you please rename it to something else? Adding an adjective or some distinctive prefix/suffix is enough.

@jonaspleyer
Copy link
Contributor Author

jonaspleyer commented May 13, 2024

Thanks for the immediate feedback. I am not quite sure how to handle this situation.

On the one hand, my package allows for deep customization of boxes which are used to build up the poster.
This way, not only one type of appearance can be generated but many more. The documentation does not properly show this at this moment but the functionality is already there. This makes it hard for me to find a suitable "specification" of the package name.
And this also makes it hard for me to justify publishing this as a template. Rather, I would prefer to publish 2 templates which use this package in order to construct a specific layout.

On the other hand, I can see that the overall contributed functionality is not as big as that of other packages which would more point towards a template rather than a plain package.

Please let me know your feedback. I can also come up with some mock-examples to show what I am getting at if desired.

@reknih reknih force-pushed the main branch 6 times, most recently from 92aab43 to d06d87c Compare May 15, 2024 10:12
@reknih
Copy link
Member

reknih commented May 22, 2024

Hey Jonas,

The naming rule is less about avoiding collisions with the standard library (and thus anticipating it, we would not want to ask that of our package authors 😅) but about no package advertising itself as THE package for something (like scientific posters) with its name.

For example, we asked the packages zine, iban-formatter, and palettes to rename. They are now called zen-zine, ibanator, and splash which allows other packages to serve their niche and compete with them and also is more memorable and fun (arguabely).

You can totally publish template packages that depend on this package and you are free to submit them in one or multiple PRs, as convenient.

So if this is the tools package it could have a name like lighthouse, poster-corner, or industrial-glue (feel free to come up with your own), with the template packages having names that riff on those or are completely separate and more related to their appearance or use case.

By the way, I enjoyed your blog post about creating posters with Typst! Can we quote it on our site?

@jonaspleyer
Copy link
Contributor Author

Hi,
Thanks for the detailed answer. I will rework my PR as suggested into a package and (possible multiple) template(s).
Of course you are very welcomed to quote my blog post. I would be very glad if you did. If you do not plan to publish this immediately I would ask for you to wait until I have reworked this PR such that users can enjoy this package/template when also having read the blog-post. I am back from my vacation now and will start working on it in the coming week.
Best,
Jonas

@jonaspleyer jonaspleyer changed the title add science-posters 0.3.0 template add peace-of-posters 0.4.0 May 30, 2024
@jonaspleyer
Copy link
Contributor Author

Hi Everyone,
I have changed the name to peace-of-posters and released it as a package instead of as a template. Furthermore, I have changed all naming conventions to use kebap-case instead of snake_case. I have made one very minor exception which is functions that are meant for private use which start (similarly to python naming conventions) with an underscore.
Please let me know what you think.

@reknih
Copy link
Member

reknih commented May 30, 2024

Name works, likewise variable naming conventions sound good

@jonaspleyer
Copy link
Contributor Author

Thanks for the very fast response. I hope that this PR can be merged now.

Copy link
Contributor

@elegaanz elegaanz left a comment

Choose a reason for hiding this comment

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

Just a typo in the homepage URL, after that it should be good to merge.

packages/preview/peace-of-posters/0.4.0/typst.toml Outdated Show resolved Hide resolved
Co-authored-by: Ana Gelez <ana+github@gelez.xyz>
@reknih reknih merged commit 6db1eff into typst:main May 31, 2024
1 check passed
@reknih
Copy link
Member

reknih commented May 31, 2024

Thanks!

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.

None yet

3 participants