Modification Markup is used to mark changes and other
features in code. It uses an XML-style format that can be used to find the editing tags quickly. It also
allows them to be processed a mechanical fashion, such as with a script. Modification markup works best
on code that is not version-controlled, but it is almost just as useful on versioned code. It also provides all
of the necessary features to be used in situations where more than one person works on a particular piece
of code. It can greatly reduce errors and aid in collaboration.
Modification Markup is currently at version 2.2.
It was originally designed by Bradley Tetzlaff on 2005-06-04.
Although it is not an official standard, it does follow the W3C XML specification 1.0.
Summary
Tags
<EDIT EDITED EDITNO /> - Edit code
<EDADD EDITED EDADDNO /> - Add code
<EDREMOVE EDREMOVED EDREMOVEDNO /> - Remove code
<EDFIX EDFIXED EDFIXNO /> - Fix code/bug
<EDIMPROVE EDIMPROVED EDIMPROVENO /> - Improve code
<EDRENAME EDRENAMED EDRENAMENO /> - Rename item
<TEST TESTED TESTNO /> - Test code
<SYNC SYNCNO /> - Keep code synchronized
<DESC /> - Describe code
<REF /> - Make a reference
<NOTE /> - Make a note
Attributes
i - Identifier for relation of tags
a - Original author's name
ra - Responder (who made the change)
r - Recipient's name
t - Original timestamp
st - Start date
et - Completion date
due - Due date
p - Priority as a set of '!'
v - Related version
sv - Initial version
ev - Completion version
title - Title of note or code
x – What the tag refers to exactly
sx – Unmodified code example
ex – Modified code example
src – An address of source information
if - Applicable only under this condition
c - Comment/Description
