Commands vs keys/values for setting up a document: what an own document class should provide?Package option...
Is it inappropriate for a student to attend their mentor's dissertation defense?
RSA: Danger of using p to create q
What typically incentivizes a professor to change jobs to a lower ranking university?
Paid for article while in US on F-1 visa?
Could an aircraft fly or hover using only jets of compressed air?
What's the output of a record needle playing an out-of-speed record
How can bays and straits be determined in a procedurally generated map?
Add text to same line using sed
Do infinite dimensional systems make sense?
Maximum likelihood parameters deviate from posterior distributions
LWC SFDX source push error TypeError: LWC1009: decl.moveTo is not a function
Can I make popcorn with any corn?
Watching something be written to a file live with tail
Is it possible to run Internet Explorer on OS X El Capitan?
Accidentally leaked the solution to an assignment, what to do now? (I'm the prof)
Rock identification in KY
Was any UN Security Council vote triple-vetoed?
How old can references or sources in a thesis be?
Does an object always see its latest internal state irrespective of thread?
meaning of に in 本当に?
Arrow those variables!
If human space travel is limited by the G force vulnerability, is there a way to counter G forces?
Can a vampire attack twice with their claws using Multiattack?
How does quantile regression compare to logistic regression with the variable split at the quantile?
Commands vs keys/values for setting up a document: what an own document class should provide?
Package option vs setup commandDocument Class for Briefing NotesAligning image and text in new command in TikZHow to change the order in new commandsWhat is the best practice for arithmetic operations specially for package/class writing?LaTeX Document class for department technical reportsCommands for getting and setting additional elements in a class and documentAre end… macro names reserved in LaTeX2e?Setting default values for LaTeX3 keysUsing later-defined commands in an own document classSetting geometry as an option in my own class
This question somehow extends the question "Package option vs setup command".
I'm currently writing a class dedicated to students reports for both academic projects and internships. This class provides a reportsetup
command that lets the user setting things up via keys/values.
For example, one thing that can be set up is the company's name of the internship. It appears that this could be done both:
- via a command:
companyname{⟨name⟩}
, - via a
key=value
:reportsetup{companyname = ⟨name⟩}
,
and this, whether the class considers the company's name mandatory or not: both commands and keys may be mandatory or optional.
This is just an example but potentially applies to all commands all classes (or packages) could provide.
What would be the best between these two practices?
macros best-practices package-writing documentclass-writing options
add a comment |
This question somehow extends the question "Package option vs setup command".
I'm currently writing a class dedicated to students reports for both academic projects and internships. This class provides a reportsetup
command that lets the user setting things up via keys/values.
For example, one thing that can be set up is the company's name of the internship. It appears that this could be done both:
- via a command:
companyname{⟨name⟩}
, - via a
key=value
:reportsetup{companyname = ⟨name⟩}
,
and this, whether the class considers the company's name mandatory or not: both commands and keys may be mandatory or optional.
This is just an example but potentially applies to all commands all classes (or packages) could provide.
What would be the best between these two practices?
macros best-practices package-writing documentclass-writing options
1
Personally, I always use setup macro for mandatory (else it will not compile) definitions and key-value-interfaces for anything else (mandatory, if feature used, optional, etc.). But I think it also comes down to personal preference.
– TeXnician
18 hours ago
add a comment |
This question somehow extends the question "Package option vs setup command".
I'm currently writing a class dedicated to students reports for both academic projects and internships. This class provides a reportsetup
command that lets the user setting things up via keys/values.
For example, one thing that can be set up is the company's name of the internship. It appears that this could be done both:
- via a command:
companyname{⟨name⟩}
, - via a
key=value
:reportsetup{companyname = ⟨name⟩}
,
and this, whether the class considers the company's name mandatory or not: both commands and keys may be mandatory or optional.
This is just an example but potentially applies to all commands all classes (or packages) could provide.
What would be the best between these two practices?
macros best-practices package-writing documentclass-writing options
This question somehow extends the question "Package option vs setup command".
I'm currently writing a class dedicated to students reports for both academic projects and internships. This class provides a reportsetup
command that lets the user setting things up via keys/values.
For example, one thing that can be set up is the company's name of the internship. It appears that this could be done both:
- via a command:
companyname{⟨name⟩}
, - via a
key=value
:reportsetup{companyname = ⟨name⟩}
,
and this, whether the class considers the company's name mandatory or not: both commands and keys may be mandatory or optional.
This is just an example but potentially applies to all commands all classes (or packages) could provide.
What would be the best between these two practices?
macros best-practices package-writing documentclass-writing options
macros best-practices package-writing documentclass-writing options
edited 8 hours ago
Denis Bitouzé
asked yesterday
Denis BitouzéDenis Bitouzé
3,60711351
3,60711351
1
Personally, I always use setup macro for mandatory (else it will not compile) definitions and key-value-interfaces for anything else (mandatory, if feature used, optional, etc.). But I think it also comes down to personal preference.
– TeXnician
18 hours ago
add a comment |
1
Personally, I always use setup macro for mandatory (else it will not compile) definitions and key-value-interfaces for anything else (mandatory, if feature used, optional, etc.). But I think it also comes down to personal preference.
– TeXnician
18 hours ago
1
1
Personally, I always use setup macro for mandatory (else it will not compile) definitions and key-value-interfaces for anything else (mandatory, if feature used, optional, etc.). But I think it also comes down to personal preference.
– TeXnician
18 hours ago
Personally, I always use setup macro for mandatory (else it will not compile) definitions and key-value-interfaces for anything else (mandatory, if feature used, optional, etc.). But I think it also comes down to personal preference.
– TeXnician
18 hours ago
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "85"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2ftex.stackexchange.com%2fquestions%2f483245%2fcommands-vs-keys-values-for-setting-up-a-document-what-an-own-document-class-sh%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to TeX - LaTeX Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2ftex.stackexchange.com%2fquestions%2f483245%2fcommands-vs-keys-values-for-setting-up-a-document-what-an-own-document-class-sh%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
1
Personally, I always use setup macro for mandatory (else it will not compile) definitions and key-value-interfaces for anything else (mandatory, if feature used, optional, etc.). But I think it also comes down to personal preference.
– TeXnician
18 hours ago