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

Better documentation for features #57

Open
andrewshadura opened this issue Aug 16, 2019 · 2 comments
Open

Better documentation for features #57

andrewshadura opened this issue Aug 16, 2019 · 2 comments

Comments

@andrewshadura
Copy link
Contributor

Hi,

I’m trying to add profiles for printers I’ve tested, but it’s a bit difficult to figure out what features mean, since some of them seem to be mandatory despite not being used e.g. by python-escpos. E.g. highDensity or starCommands (the latter is probably proprietary commands Star printer support?).

Could you please document them?

Thanks!

@mike42
Copy link
Collaborator

mike42 commented Aug 16, 2019

I've labeled this as an enhancement because I agree that it would be useful, though I'm not planning on adding it myself any time soon (pull requests welcome).

We would ideally make this machine-readable, and bundle it with the database itself (eg. as features.yml), since some projects such as this could display the values, and our own build process could use the list in place of the current hard-coded values.

To address your current sticking point though, yes many fields are mandatory. You don't need to include them in your own profile though, I would recommend extending a base profile (or a profile for a similar printer), so that you only need to specify the differences.

For example, the AF-240 profile uses inherits: simple, and does not specify starCommands.

@andrewshadura
Copy link
Contributor Author

andrewshadura commented Aug 16, 2019

Well, if you could at least explain (e.g. here) what those features refer to, I could write the missing documentation.

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

No branches or pull requests

2 participants