Skip to content

Commit 95e8bea

Browse files
okohlbacherclaude
andcommitted
merge(999.70-01): TUT-01 tutorial.tex refresh — URLs, release tag, roster, citation
- Refresh outbound URLs (http->https ball-project.org; dead pdb4pti.ent path), release tag, and build-doc pointers (build steps already removed per #560). - Update author/developer roster + add canonical BMC 2010 citation to tutorial.bib. TUT-01 PDF render + screenshot recapture remain Wave-2 (human, plan 999.70-03). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2 parents 28676e4 + 74bb2ba commit 95e8bea

5 files changed

Lines changed: 50 additions & 18 deletions

File tree

doc/TUTORIAL/example4.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ \section{The BALL File Class}
99

1010
\begin{lstlisting}{}
1111
PDBFile
12-
infile("http://www.ball-project.org/Downloads/Examples/pdb4pti.ent");
12+
infile("https://files.rcsb.org/download/4PTI.pdb");
1313
System S;
1414
infile >> S;
1515
infile.close();
1616
\end{lstlisting}
1717

1818
\noindent
19-
This command retrieves the file {\tt pdb4pti.ent} from its location at the BALL
20-
project site using the HTTP protocol and reads the contents of that file into a
19+
This command retrieves the PDB entry {\tt 4PTI} directly from the RCSB Protein
20+
Data Bank using the HTTP protocol and reads the contents of that file into a
2121
\class{System}. The retrieval and the expansion of the URL into something
2222
meaningful is performed by the classes \class{TransformationManager} and
2323
\class{TCPTransfer}. Any filename is first handed to the static instance of

doc/TUTORIAL/faq.tex

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
\FAQCategory{Documentation}
22
\FAQquestion{Are there Research reports available?}
3-
\FAQanswer{Yes. Publications and research reports on BALL are listed on our website:
4-
\FAQURL{http://www.ball-project.org}
3+
\FAQanswer{Yes. Publications and research reports on BALL are listed on our website:
4+
\FAQURL{https://ball-project.org}
55
}
66
\FAQquestion{Where do I get the latest version?}
7-
\FAQanswer{The latest version of BALL, bug fixes, and updates are available from our
8-
website
9-
\FAQURL{http://www.ball-project.org}
7+
\FAQanswer{Pre-built BALLView packages for macOS, Windows, and Linux are published on the
8+
GitHub Releases page
9+
\FAQURL{https://github.com/BALL-Project/ball/releases/latest}
1010
}
1111
\FAQquestion{Is there further documentation besides this document?}
12-
\FAQanswer{Further documentation, a Wiki and a bug tracker, can be found on
12+
\FAQanswer{Further documentation, a Wiki and a bug tracker, can be found on
1313
\FAQURL{https://github.com/BALL-Project/ball/}
1414
providing a Code Library with Code snippets, further tutorials, Release Notes, and FAQs.
1515
}
1616
\FAQquestion{How do I use BALLView?}
17-
\FAQanswer{Take a look at the built-in BALLView Tutorial or on the documentation at http://www.ball-project.org/Documentation}
17+
\FAQanswer{Take a look at the built-in BALLView Tutorial or at the project wiki at \FAQURL{https://github.com/BALL-Project/ball/wiki}}
1818
\FAQCategory{Installation}
1919
\FAQquestion{Will BALL run on my hardware/with my compiler?}
2020
\FAQanswer{BALL should run on all major current platforms, in particular Linux, MacOS X, and Windows. Older BALL

doc/TUTORIAL/introduction.tex

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,36 @@
1111
Manual}~\cite{BALL-RM} which can be obtained in HTML, PDF, or postscript format.
1212

1313
There are also several papers and technical reports published on
14-
BALL~\cite{BKL99a,BKL99b,KL99,Koh2001,KL2000,MHLK05,MHLK06}
14+
BALL~\cite{Hildebrandt2010BALL,BKL99a,BKL99b,KL99,Koh2001,KL2000,MHLK05,MHLK06}
1515
that give a cursory overview of its design principles and illustrate its use in
16-
Rapid Software Prototyping. If you publish results that were obtained using
16+
Rapid Software Prototyping. If you publish results that were obtained using
1717
BALL, please cite it as follows:
1818
\begin{enumerate}
19+
\item[] A. Hildebrandt, A. K. Dehof, A. Rurainski, A. Bertsch,
20+
M. Schumann, N. C. Toussaint, A. Moll, D. St\"{o}ckel,
21+
S. Nickels, S. C. M\"{u}ller, H.-P. Lenhof, O. Kohlbacher:
22+
BALL -- Biochemical Algorithms Library 1.3,
23+
{\em BMC Bioinformatics} 2010, 11:531
24+
(DOI: 10.1186/1471-2105-11-531).
1925
\item[] O. Kohlbacher, H.-P. Lenhof: BALL -- Rapid Software Prototyping
2026
in Computational Molecular Biology, {\em Bioinformatics} 2000,
2127
16(9):815--824.
2228
\end{enumerate}
2329

2430
\noindent
25-
The latest version of BALL, bug fixes, and updates are available from our
31+
The latest version of BALL, bug fixes, and updates are available from our
2632
website
2733

2834
\begin{enumerate}
29-
\item[] \URL{http://www.ball-project.org}.
35+
\item[] \URL{https://ball-project.org}
36+
\end{enumerate}
37+
38+
\noindent
39+
Pre-built BALLView packages for macOS, Windows, and Linux are published on the
40+
GitHub Releases page
41+
42+
\begin{enumerate}
43+
\item[] \URL{https://github.com/BALL-Project/ball/releases/latest}
3044
\end{enumerate}
3145

3246
\noindent

doc/TUTORIAL/tutorial.bib

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
1+
@article{Hildebrandt2010BALL,
2+
author = {Hildebrandt, A. and Dehof, A. K. and Rurainski, A.
3+
and Bertsch, A. and Schumann, M. and Toussaint, N. C.
4+
and Moll, A. and St\"{o}ckel, D. and Nickels, S.
5+
and M\"{u}ller, S. C. and Lenhof, H.-P.
6+
and Kohlbacher, O.},
7+
title = {{BALL} -- {B}iochemical {A}lgorithms {L}ibrary 1.3},
8+
journal = {BMC Bioinformatics},
9+
year = {2010},
10+
volume = {11},
11+
pages = {531},
12+
doi = {10.1186/1471-2105-11-531},
13+
}
14+
115
@inproceedings{BKL99b,
2-
author = {Boghossian, N. P. and Kohlbacher, O. and Lenhof, H.-P.},
16+
author = {Boghossian, N. P. and Kohlbacher, O. and Lenhof, H.-P.},
317
editor = {Vitter, J. S. and Zaroliagis, C. D.},
418
title = {{BALL}: {B}iochemical {A}lgorithms {L}ibrary},
519
booktitle = {Algorithm Engineering, 3rd International Workshop, {WAE}'99,

doc/TUTORIAL/tutorial.tex

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
\documentclass[12pt,twoside]{report}
22

33
\author{
4-
Oliver Kohlbacher, Heiko Klein, Andreas Kerzmann, \\
5-
Andreas Moll, Andreas K\"{a}mper, Anna Katharina Dehof, Andreas Hildebrandt
4+
Andreas Hildebrandt, Anna Katharina Dehof, Alexander Rurainski, \\
5+
Andreas Bertsch, Marcel Schumann, Nora C. Toussaint, Andreas Moll, \\
6+
Daniel St\"{o}ckel, Stefan Nickels, Sabine C. M\"{u}ller, \\
7+
Heiko Klein, Andreas Kerzmann, Andreas K\"{a}mper, \\
8+
Hans-Peter Lenhof, Oliver Kohlbacher
9+
% TODO(999.70): confirm current maintainer roster
610
}
711
\title{
812
\begin{center}
@@ -12,7 +16,7 @@
1216
\Large A Tutorial
1317
}
1418
\date{
15-
Release 1.7\\
19+
Release 1.7.4\\
1620
\today
1721
}
1822

0 commit comments

Comments
 (0)