Commands vs options for setting up a document: what an own document class should provide?Package option vs...

Should I tell management that I intend to leave due to bad software development practices?

Took a trip to a parallel universe, need help deciphering

Can a virus destroy the BIOS of a modern computer?

Did Shadowfax go to Valinor?

I'm flying to France today and my passport expires in less than 2 months

Will google still index a page if I use a $_SESSION variable?

Can a rocket refuel on Mars from water?

How can I prevent hyper evolved versions of regular creatures from wiping out their cousins?

Why is Collection not simply treated as Collection<?>

Arrow those variables!

Can I use a neutral wire from another outlet to repair a broken neutral?

What mechanic is there to disable a threat instead of killing it?

Withdrawals from HSA

Where does SFDX store details about scratch orgs?

What exploit are these user agents trying to use?

Combinations of multiple lists

Emailing HOD to enhance faculty application

In Romance of the Three Kingdoms why do people still use bamboo sticks when papers are already invented?

Etiquette around loan refinance - decision is going to cost first broker a lot of money

Neighboring nodes in the network

How can I tell someone that I want to be his or her friend?

Is it unprofessional to ask if a job posting on GlassDoor is real?

How to take photos in burst mode, without vibration?

Did converts (ger tzedek) in ancient Israel own land?



Commands vs options for setting up a document: what an own document class should provide?


Package option vs setup commandHow can one undefine an already processed class option?Best practice for setting package options through class options?When writing my own document class, certain options don't get passed to base class. Why?Line break (continuation) for commands (options, arguments)Aligning image and text in new command in TikZWhat is the best practice for arithmetic operations specially for package/class writing?Commands for getting and setting additional elements in a class and documentBest way to manage internationalisation of a class?Using later-defined commands in an own document classSetting geometry as an option in my own class













0















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 an option reportsetup{companyname = ⟨name⟩},


and this, whether the class considers the company's name mandatory or not: both commands and options 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?










share|improve this question



























    0















    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 an option reportsetup{companyname = ⟨name⟩},


    and this, whether the class considers the company's name mandatory or not: both commands and options 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?










    share|improve this question

























      0












      0








      0








      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 an option reportsetup{companyname = ⟨name⟩},


      and this, whether the class considers the company's name mandatory or not: both commands and options 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?










      share|improve this question














      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 an option reportsetup{companyname = ⟨name⟩},


      and this, whether the class considers the company's name mandatory or not: both commands and options 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






      share|improve this question













      share|improve this question











      share|improve this question




      share|improve this question










      asked 3 hours ago









      Denis BitouzéDenis Bitouzé

      3,60711350




      3,60711350






















          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
          });


          }
          });














          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2ftex.stackexchange.com%2fquestions%2f483245%2fcommands-vs-options-for-setting-up-a-document-what-an-own-document-class-should%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
















          draft saved

          draft discarded




















































          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.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2ftex.stackexchange.com%2fquestions%2f483245%2fcommands-vs-options-for-setting-up-a-document-what-an-own-document-class-should%23new-answer', 'question_page');
          }
          );

          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







          Popular posts from this blog

          Installing LyX: “No textclass is found.”LyX installation error- text class not found- 'Reconfigure' or...

          (1602) Indiana Índice Designación y nombre Características orbitales Véase...

          Universidad Autónoma de Occidente Índice Historia Campus Facultades Programas Académicos Medios de...