This contains the code for the Markup UK Proceedings, including a couple of files that customise a modified v 1.79 of the DocBook XSLT 1.0 stylesheets.
- Fork the
MarkupUK/MUK-proc
repository on GitHub - Clone your fork to your computer:
git clone https://github.com/your-username/MUK-proc.git
- Change directory to the new clone:
cd MUK-proc
- Checkout the
muk2019
branch:git checkout muk2019
- Pull both the
muk2019
branch and theMUK-xsl
submodule that it uses:git pull --recurse-submodules origin muk2019
- Format the proceedings and/or make changes to the XML and XSLT
Automated formatting requires Apache Ant and AH Formatter.
- Check that the properties defined in
properties.xml
are correct for your installation.
- If a property needs to be changed for everyone, edit
properties.xml
and then commit your changes - If a property, such as for the location of a file, needs to be changed only for your installation, copy
properties.xml
toproperties.local.xml
and edit that file so that it contains only your property overrides. The definitions inproperties.local.xml
(if it exists) have precedence over the properties inproperties.xml
because Ant readsproperties.local.xml
beforeproperties.xml
.
- Run Ant:
If Ant skips stages because it isn't detecting changes in your files, force all stages to run:
ant -emacs
ant -emacs -Dforce=yes
When you have changes that are not in the xsl
subdirectory:
- Make sure that your repository is up to date with
MarkupUK/MUK-proc
:- View the
muk2019
branch of your repository on GitHub in your browser (Reload the page if you got there by using the back button) - If your branch is out of date, there will be an indication of how many commits your branch is behind
- Click on 'Fetch upstream' and then 'Fetch and merge' to merge upstream changes into your fork:
- Pull the upstream changes to your local repository:
You may need to use
git pull origin muk2019
git stash
andgit stash pop
before and after thegit pull
to save and restore your local changes to avoid conflicts from the merge
- View the
- Create a new branch for your changes:
git checkout -b my-new-branch
- Make your changes (if they haven't been made already)
- Review your changes:
git diff
- Commit your changes; for example:
git add README.md git commit -m"Instructions for making changes."
- Push your commits to your repository on GitHub:
git push -u origin my-new-branch
- On GitHub, make a pull request to merge your changes in
my-new-branch
into themuk2019
branch ofMarkupUK/MUK-proc
That's a whole different kettle of fish...