Record changes for removed macro in dtx
Following the advice in How to Package Your LATEX Package by Scott Pakin I am recording changes to a package I maintain, similar to the following:
RecordChanges
begin{macro}{somemacro}
changes{0.1}{2018/01/01}{Added a shiny new macro}
begin{macrocode}
…
end{macrocode}
end{macro}
PrintChanges
However, if I eventually want to remove the somemacro command in version 2.0 of the package, I would like to be able to retain the old change history but not show the macro in the package otherwise.
Is there some way to hide the begin{macro} from rendering the macro name in the sidebar, or remove the begin{macro} entirely and manually specify the macro that the change lines should be under in the changelog (so that they don't just show up under the general one)?
dtx changes
asked Feb 24 at 17:04
Sam WhitedSam Whited
2,6181528
add a comment |
Following the advice in How to Package Your LATEX Package by Scott Pakin I am recording changes to a package I maintain, similar to the following:
RecordChanges
begin{macro}{somemacro}
changes{0.1}{2018/01/01}{Added a shiny new macro}
begin{macrocode}
…
end{macrocode}
end{macro}
PrintChanges
However, if I eventually want to remove the somemacro command in version 2.0 of the package, I would like to be able to retain the old change history but not show the macro in the package otherwise.
Is there some way to hide the begin{macro} from rendering the macro name in the sidebar, or remove the begin{macro} entirely and manually specify the macro that the change lines should be under in the changelog (so that they don't just show up under the general one)?
dtx changes
asked Feb 24 at 17:04
Sam WhitedSam Whited
2,6181528
1
I think you can replacebegin{macro}bybegingroupedefsaved@macroname{stringsomemacro}%(untested as you didn't supply a test file....)
– David Carlisle
Feb 24 at 17:12
Thanks for the suggestion! Unfortunately, any changes inside that begingroupendgroup don't seem to show up at all (not even in the "general" section of the change log)
– Sam Whited
Feb 24 at 17:20
The DTX format really dates from the days when one wouldn't actually remove the lines at all, but rather comment them out. That goes with the fact that in (La)TeX someone will depend on every single internal macro you have ... so you probably have to keep some record of all of them in the sources.
– Joseph Wright♦
Feb 24 at 17:30
@SamWhited macro doesn't do anything much other than print the name and set up that indexing so something along those lines will work, but as I say above no example no test.
– David Carlisle
Feb 24 at 17:33
add a comment |
Following the advice in How to Package Your LATEX Package by Scott Pakin I am recording changes to a package I maintain, similar to the following:
RecordChanges
begin{macro}{somemacro}
changes{0.1}{2018/01/01}{Added a shiny new macro}
begin{macrocode}
…
end{macrocode}
end{macro}
PrintChanges
However, if I eventually want to remove the somemacro command in version 2.0 of the package, I would like to be able to retain the old change history but not show the macro in the package otherwise.
Is there some way to hide the begin{macro} from rendering the macro name in the sidebar, or remove the begin{macro} entirely and manually specify the macro that the change lines should be under in the changelog (so that they don't just show up under the general one)?
dtx changes
asked Feb 24 at 17:04
Sam WhitedSam Whited
2,6181528
Following the advice in How to Package Your LATEX Package by Scott Pakin I am recording changes to a package I maintain, similar to the following:
RecordChanges
begin{macro}{somemacro}
changes{0.1}{2018/01/01}{Added a shiny new macro}
begin{macrocode}
…
end{macrocode}
end{macro}
PrintChanges
However, if I eventually want to remove the somemacro command in version 2.0 of the package, I would like to be able to retain the old change history but not show the macro in the package otherwise.
Is there some way to hide the begin{macro} from rendering the macro name in the sidebar, or remove the begin{macro} entirely and manually specify the macro that the change lines should be under in the changelog (so that they don't just show up under the general one)?
dtx changes
dtx changes
asked Feb 24 at 17:04
Sam WhitedSam Whited
2,6181528
asked Feb 24 at 17:04
Sam WhitedSam Whited
2,6181528
asked Feb 24 at 17:04
Sam WhitedSam Whited
2,6181528
asked Feb 24 at 17:04
Sam WhitedSam Whited
2,6181528
asked Feb 24 at 17:04
Sam WhitedSam Whited
2,6181528
2,6181528
1
I think you can replacebegin{macro}bybegingroupedefsaved@macroname{stringsomemacro}%(untested as you didn't supply a test file....)
– David Carlisle
Feb 24 at 17:12
Thanks for the suggestion! Unfortunately, any changes inside that begingroupendgroup don't seem to show up at all (not even in the "general" section of the change log)
– Sam Whited
Feb 24 at 17:20
The DTX format really dates from the days when one wouldn't actually remove the lines at all, but rather comment them out. That goes with the fact that in (La)TeX someone will depend on every single internal macro you have ... so you probably have to keep some record of all of them in the sources.
– Joseph Wright♦
Feb 24 at 17:30
@SamWhited macro doesn't do anything much other than print the name and set up that indexing so something along those lines will work, but as I say above no example no test.
– David Carlisle
Feb 24 at 17:33
add a comment |
1
I think you can replacebegin{macro}bybegingroupedefsaved@macroname{stringsomemacro}%(untested as you didn't supply a test file....)
– David Carlisle
Feb 24 at 17:12
Thanks for the suggestion! Unfortunately, any changes inside that begingroupendgroup don't seem to show up at all (not even in the "general" section of the change log)
– Sam Whited
Feb 24 at 17:20
The DTX format really dates from the days when one wouldn't actually remove the lines at all, but rather comment them out. That goes with the fact that in (La)TeX someone will depend on every single internal macro you have ... so you probably have to keep some record of all of them in the sources.
– Joseph Wright♦
Feb 24 at 17:30
@SamWhited macro doesn't do anything much other than print the name and set up that indexing so something along those lines will work, but as I say above no example no test.
– David Carlisle
Feb 24 at 17:33
1
1
I think you can replace
begin{macro} by begingroupedefsaved@macroname{stringsomemacro}% (untested as you didn't supply a test file....)– David Carlisle
Feb 24 at 17:12
I think you can replace
begin{macro} by begingroupedefsaved@macroname{stringsomemacro}% (untested as you didn't supply a test file....)– David Carlisle
Feb 24 at 17:12
Thanks for the suggestion! Unfortunately, any changes inside that begingroupendgroup don't seem to show up at all (not even in the "general" section of the change log)
– Sam Whited
Feb 24 at 17:20
Thanks for the suggestion! Unfortunately, any changes inside that begingroupendgroup don't seem to show up at all (not even in the "general" section of the change log)
– Sam Whited
Feb 24 at 17:20
The DTX format really dates from the days when one wouldn't actually remove the lines at all, but rather comment them out. That goes with the fact that in (La)TeX someone will depend on every single internal macro you have ... so you probably have to keep some record of all of them in the sources.
– Joseph Wright♦
Feb 24 at 17:30
The DTX format really dates from the days when one wouldn't actually remove the lines at all, but rather comment them out. That goes with the fact that in (La)TeX someone will depend on every single internal macro you have ... so you probably have to keep some record of all of them in the sources.
– Joseph Wright♦
Feb 24 at 17:30
@SamWhited macro doesn't do anything much other than print the name and set up that indexing so something along those lines will work, but as I say above no example no test.
– David Carlisle
Feb 24 at 17:33
@SamWhited macro doesn't do anything much other than print the name and set up that indexing so something along those lines will work, but as I say above no example no test.
– David Carlisle
Feb 24 at 17:33
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%2f476472%2frecord-changes-for-removed-macro-in-dtx%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%2f476472%2frecord-changes-for-removed-macro-in-dtx%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
I think you can replace
begin{macro}bybegingroupedefsaved@macroname{stringsomemacro}%(untested as you didn't supply a test file....)– David Carlisle
Feb 24 at 17:12
Thanks for the suggestion! Unfortunately, any changes inside that begingroupendgroup don't seem to show up at all (not even in the "general" section of the change log)
– Sam Whited
Feb 24 at 17:20
The DTX format really dates from the days when one wouldn't actually remove the lines at all, but rather comment them out. That goes with the fact that in (La)TeX someone will depend on every single internal macro you have ... so you probably have to keep some record of all of them in the sources.
– Joseph Wright♦
Feb 24 at 17:30
@SamWhited macro doesn't do anything much other than print the name and set up that indexing so something along those lines will work, but as I say above no example no test.
– David Carlisle
Feb 24 at 17:33