Templates in DocTeX : Documenting and producing code within the macrocode environmentSide-by-side source and...

Is there a way to not have to poll the UART of an AVR?

Why did Luke use his left hand to shoot?

Can we "borrow" our answers to populate our own websites?

Equivalent of "illegal" for violating civil law

Why do all the books in Game of Thrones library have their covers facing the back of the shelf?

Converting very wide logos to square formats

How vim overwrites readonly mode?

Not a Long-Winded Riddle

Do authors have to be politically correct in article-writing?

When Are Enum Values Defined?

Stuck on a Geometry Puzzle

How does Leonard in "Memento" remember reading and writing?

What is the wife of a henpecked husband called?

Subsurf on a crown. How can I smooth some edges and keep others sharp?

Does an Eldritch Knight's Weapon Bond protect him from losing his weapon to a Telekinesis spell?

Could a warlock use the One with Shadows warlock invocation to turn invisible, and then move while staying invisible?

Coworker asking me to not bring cakes due to self control issue. What should I do?

Count repetitions of an array

Taking headphones when quitting job

Categorical Unification of Jordan Holder Theorems

Can a player sacrifice a creature after declaring that creature as blocker while taking lethal damage?

Why avoid shared user accounts?

Potential client has a problematic employee I can't work with

Why is the "Domain users" group missing from this Powershell AD Query?



Templates in DocTeX : Documenting and producing code within the macrocode environment


Side-by-side source and output when documenting a style fileAdd something to the driver section inside the package code using OnlyDescriptionIs it possible to hide long comments within the editor?Does DocStrip dislike glossaries?How to use the comment package within a footnote?How to set macrocode using the listings packageToggling the visibility of personal notes within a paragraphChange macrocode environment colour when documenting package with ltxdocHow to create a boilerplate dtx file for a package using LaTeX3 (similar to dtxgen for LaTeX2e)Comment Environment within a tabular environment













1















I'm writing a DocTeX file (*.dtx) to create a family of classes. From this file I am also generating and documenting the templates that illustrate their usage.



%iffalse
%<*template>
%fi
%
% There are now two versions of the package{invoice} Package
%
% begin{macrocode}
%<VersionA>documentclass{CustomInvoiceA}
%<VersionB>documentclass{CustomInvoiceB}
% end{macrocode}
%
%iffalse
%</template>
%fi


For the most part this is working well but I can't seem to shake the guards (HTML like tags) in the documented code and I'm not sure where I'm going wrong



Output showing HTML like guards



From Scott Pakins' DTX tutorial (Invoke texdoc --view dtxtut from the command line to view at home) the following summary table is useful for determining where code will usually apply but the behavior is different within a macrocode environment.




Scott Pakin : DTXTtut : Comment Table



Is it possible to remove the <GUARDS> in the output (The first image) ? I know I could move the <GUARDS> from the macrocode environment into additional iffalse...fi but I would prefer not to pepper the document with these statements everywhere, perhaps there is another way.










share|improve this question




















  • 2





    what is your question exactly? the output you show is what I would expect.

    – David Carlisle
    Dec 8 '18 at 1:04











  • @DavidCarlisle I was hoping to remove the tags in the output, is this the expected behaviour ? (I updated the question to include one)

    – Carel
    Dec 8 '18 at 8:39






  • 1





    Normally the docstrip tags allow you to make multiple files but with a shared documentation, so without the tags the documentation would be very hard t follow, eg the image you show it would look like a document with two documentclass but as it is it document that two documents will be made, and shows the documentclass in each

    – David Carlisle
    Dec 8 '18 at 9:51













  • Ah so I'm fighting the design, I wasn't sure.

    – Carel
    Dec 8 '18 at 10:04











  • @DavidCarlisle Coincidentally could one stylize the tags instead with say rounded rectangles in different colours or would that be a bit gaudy ?

    – Carel
    Dec 8 '18 at 10:09
















1















I'm writing a DocTeX file (*.dtx) to create a family of classes. From this file I am also generating and documenting the templates that illustrate their usage.



%iffalse
%<*template>
%fi
%
% There are now two versions of the package{invoice} Package
%
% begin{macrocode}
%<VersionA>documentclass{CustomInvoiceA}
%<VersionB>documentclass{CustomInvoiceB}
% end{macrocode}
%
%iffalse
%</template>
%fi


For the most part this is working well but I can't seem to shake the guards (HTML like tags) in the documented code and I'm not sure where I'm going wrong



Output showing HTML like guards



From Scott Pakins' DTX tutorial (Invoke texdoc --view dtxtut from the command line to view at home) the following summary table is useful for determining where code will usually apply but the behavior is different within a macrocode environment.




Scott Pakin : DTXTtut : Comment Table



Is it possible to remove the <GUARDS> in the output (The first image) ? I know I could move the <GUARDS> from the macrocode environment into additional iffalse...fi but I would prefer not to pepper the document with these statements everywhere, perhaps there is another way.










share|improve this question




















  • 2





    what is your question exactly? the output you show is what I would expect.

    – David Carlisle
    Dec 8 '18 at 1:04











  • @DavidCarlisle I was hoping to remove the tags in the output, is this the expected behaviour ? (I updated the question to include one)

    – Carel
    Dec 8 '18 at 8:39






  • 1





    Normally the docstrip tags allow you to make multiple files but with a shared documentation, so without the tags the documentation would be very hard t follow, eg the image you show it would look like a document with two documentclass but as it is it document that two documents will be made, and shows the documentclass in each

    – David Carlisle
    Dec 8 '18 at 9:51













  • Ah so I'm fighting the design, I wasn't sure.

    – Carel
    Dec 8 '18 at 10:04











  • @DavidCarlisle Coincidentally could one stylize the tags instead with say rounded rectangles in different colours or would that be a bit gaudy ?

    – Carel
    Dec 8 '18 at 10:09














1












1








1








I'm writing a DocTeX file (*.dtx) to create a family of classes. From this file I am also generating and documenting the templates that illustrate their usage.



%iffalse
%<*template>
%fi
%
% There are now two versions of the package{invoice} Package
%
% begin{macrocode}
%<VersionA>documentclass{CustomInvoiceA}
%<VersionB>documentclass{CustomInvoiceB}
% end{macrocode}
%
%iffalse
%</template>
%fi


For the most part this is working well but I can't seem to shake the guards (HTML like tags) in the documented code and I'm not sure where I'm going wrong



Output showing HTML like guards



From Scott Pakins' DTX tutorial (Invoke texdoc --view dtxtut from the command line to view at home) the following summary table is useful for determining where code will usually apply but the behavior is different within a macrocode environment.




Scott Pakin : DTXTtut : Comment Table



Is it possible to remove the <GUARDS> in the output (The first image) ? I know I could move the <GUARDS> from the macrocode environment into additional iffalse...fi but I would prefer not to pepper the document with these statements everywhere, perhaps there is another way.










share|improve this question
















I'm writing a DocTeX file (*.dtx) to create a family of classes. From this file I am also generating and documenting the templates that illustrate their usage.



%iffalse
%<*template>
%fi
%
% There are now two versions of the package{invoice} Package
%
% begin{macrocode}
%<VersionA>documentclass{CustomInvoiceA}
%<VersionB>documentclass{CustomInvoiceB}
% end{macrocode}
%
%iffalse
%</template>
%fi


For the most part this is working well but I can't seem to shake the guards (HTML like tags) in the documented code and I'm not sure where I'm going wrong



Output showing HTML like guards



From Scott Pakins' DTX tutorial (Invoke texdoc --view dtxtut from the command line to view at home) the following summary table is useful for determining where code will usually apply but the behavior is different within a macrocode environment.




Scott Pakin : DTXTtut : Comment Table



Is it possible to remove the <GUARDS> in the output (The first image) ? I know I could move the <GUARDS> from the macrocode environment into additional iffalse...fi but I would prefer not to pepper the document with these statements everywhere, perhaps there is another way.







comments dtx docstrip






share|improve this question















share|improve this question













share|improve this question




share|improve this question








edited 30 mins ago









Henri Menke

75.7k8165277




75.7k8165277










asked Dec 7 '18 at 23:49









CarelCarel

638513




638513








  • 2





    what is your question exactly? the output you show is what I would expect.

    – David Carlisle
    Dec 8 '18 at 1:04











  • @DavidCarlisle I was hoping to remove the tags in the output, is this the expected behaviour ? (I updated the question to include one)

    – Carel
    Dec 8 '18 at 8:39






  • 1





    Normally the docstrip tags allow you to make multiple files but with a shared documentation, so without the tags the documentation would be very hard t follow, eg the image you show it would look like a document with two documentclass but as it is it document that two documents will be made, and shows the documentclass in each

    – David Carlisle
    Dec 8 '18 at 9:51













  • Ah so I'm fighting the design, I wasn't sure.

    – Carel
    Dec 8 '18 at 10:04











  • @DavidCarlisle Coincidentally could one stylize the tags instead with say rounded rectangles in different colours or would that be a bit gaudy ?

    – Carel
    Dec 8 '18 at 10:09














  • 2





    what is your question exactly? the output you show is what I would expect.

    – David Carlisle
    Dec 8 '18 at 1:04











  • @DavidCarlisle I was hoping to remove the tags in the output, is this the expected behaviour ? (I updated the question to include one)

    – Carel
    Dec 8 '18 at 8:39






  • 1





    Normally the docstrip tags allow you to make multiple files but with a shared documentation, so without the tags the documentation would be very hard t follow, eg the image you show it would look like a document with two documentclass but as it is it document that two documents will be made, and shows the documentclass in each

    – David Carlisle
    Dec 8 '18 at 9:51













  • Ah so I'm fighting the design, I wasn't sure.

    – Carel
    Dec 8 '18 at 10:04











  • @DavidCarlisle Coincidentally could one stylize the tags instead with say rounded rectangles in different colours or would that be a bit gaudy ?

    – Carel
    Dec 8 '18 at 10:09








2




2





what is your question exactly? the output you show is what I would expect.

– David Carlisle
Dec 8 '18 at 1:04





what is your question exactly? the output you show is what I would expect.

– David Carlisle
Dec 8 '18 at 1:04













@DavidCarlisle I was hoping to remove the tags in the output, is this the expected behaviour ? (I updated the question to include one)

– Carel
Dec 8 '18 at 8:39





@DavidCarlisle I was hoping to remove the tags in the output, is this the expected behaviour ? (I updated the question to include one)

– Carel
Dec 8 '18 at 8:39




1




1





Normally the docstrip tags allow you to make multiple files but with a shared documentation, so without the tags the documentation would be very hard t follow, eg the image you show it would look like a document with two documentclass but as it is it document that two documents will be made, and shows the documentclass in each

– David Carlisle
Dec 8 '18 at 9:51







Normally the docstrip tags allow you to make multiple files but with a shared documentation, so without the tags the documentation would be very hard t follow, eg the image you show it would look like a document with two documentclass but as it is it document that two documents will be made, and shows the documentclass in each

– David Carlisle
Dec 8 '18 at 9:51















Ah so I'm fighting the design, I wasn't sure.

– Carel
Dec 8 '18 at 10:04





Ah so I'm fighting the design, I wasn't sure.

– Carel
Dec 8 '18 at 10:04













@DavidCarlisle Coincidentally could one stylize the tags instead with say rounded rectangles in different colours or would that be a bit gaudy ?

– Carel
Dec 8 '18 at 10:09





@DavidCarlisle Coincidentally could one stylize the tags instead with say rounded rectangles in different colours or would that be a bit gaudy ?

– Carel
Dec 8 '18 at 10:09










1 Answer
1






active

oldest

votes


















0














The answer to this is "Nope Dummy !!! Don't fight the design". I'll run through the document and fix my really bad tag name choices instead.






share|improve this answer























    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%2f463754%2ftemplates-in-doctex-documenting-and-producing-code-within-the-macrocode-enviro%23new-answer', 'question_page');
    }
    );

    Post as a guest















    Required, but never shown

























    1 Answer
    1






    active

    oldest

    votes








    1 Answer
    1






    active

    oldest

    votes









    active

    oldest

    votes






    active

    oldest

    votes









    0














    The answer to this is "Nope Dummy !!! Don't fight the design". I'll run through the document and fix my really bad tag name choices instead.






    share|improve this answer




























      0














      The answer to this is "Nope Dummy !!! Don't fight the design". I'll run through the document and fix my really bad tag name choices instead.






      share|improve this answer


























        0












        0








        0







        The answer to this is "Nope Dummy !!! Don't fight the design". I'll run through the document and fix my really bad tag name choices instead.






        share|improve this answer













        The answer to this is "Nope Dummy !!! Don't fight the design". I'll run through the document and fix my really bad tag name choices instead.







        share|improve this answer












        share|improve this answer



        share|improve this answer










        answered Dec 8 '18 at 10:07









        CarelCarel

        638513




        638513






























            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%2f463754%2ftemplates-in-doctex-documenting-and-producing-code-within-the-macrocode-enviro%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

            Paper upload error, “Upload failed: The top margin is 0.715 in on page 3, which is below the required...

            Emraan Hashmi Filmografia | Linki zewnętrzne | Menu nawigacyjneGulshan GroverGulshan...

            How can I write this formula?newline and italics added with leqWhy does widehat behave differently if I...