Skip to content

Commit 6b4f4b9

Browse files
author
Sebastian Krieter
committed
Initial commit
0 parents  commit 6b4f4b9

31 files changed

+31996
-0
lines changed

‎.github/workflows/test.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Test literature
2+
3+
on:
4+
push:
5+
branches: [ '**' ]
6+
7+
jobs:
8+
test:
9+
runs-on: ubuntu-latest
10+
strategy:
11+
fail-fast: false
12+
matrix:
13+
python-version: ["3.11"]
14+
steps:
15+
- uses: actions/checkout@v4
16+
- name: Set up Python ${{ matrix.python-version }}
17+
uses: actions/setup-python@v3
18+
with:
19+
python-version: ${{ matrix.python-version }}
20+
- uses: actions/setup-java@v4
21+
with:
22+
distribution: 'temurin'
23+
java-version: '21'
24+
- name: Test literature
25+
uses: xu-cheng/texlive-action@v2
26+
with:
27+
scheme: small
28+
run: |
29+
tlmgr install csquotes
30+
./run test
31+
- name: Archive logs
32+
uses: actions/upload-artifact@v4
33+
with:
34+
name: Logs
35+
path: test/log
36+
retention-days: 30
37+
- name: Archive PDFs
38+
uses: actions/upload-artifact@v4
39+
with:
40+
name: PDFs
41+
path: test/pdf
42+
retention-days: 30

‎.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
scripts/python/python_bibtags
2+
literature/literature-cleaned.bib
3+
literature/literature.backup.bib
4+
literature/pdf
5+
literature/log
6+
test/
7+
python/

‎COPYING

+674
Large diffs are not rendered by default.

‎COPYING.LESSER

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README.md

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# BibTags
2+
3+
This is BibTags. A bibtex library containing many literature references to papers in computer science with a focus on variability and software product lines.
4+
5+
## How To Use
6+
7+
1. Clone this repo or add as a submodule
8+
2. Run `./run clean`.
9+
3. Use `MYshort.bib` and `literature-cleaned.bib` as bibliography files in your LaTeX document
10+
11+
## How to Edit
12+
13+
1. Clone this repo
14+
2. Create a branch
15+
3. Modify `literature.bib` and if necessary `MYshort.bib` and `MYabrv.bib`. __Pay attention to the policies and hints below!__
16+
4. Run `./run sort`. __Pay attention to the console output! On error go to 3.__
17+
5. Run `./run test`. __Pay attention to the console output! On error or warning go to 3.__
18+
6. Commit and push your changes
19+
7. Make a pull request to the original repo
20+
21+
## Policies
22+
- **Maintain consistent order of attributes** of entries. If you want to add a new entry, a good strategy is to copy an existing entry of the same type and adapt it.
23+
- **Keys are formatted** using author names, publication venue, and year of publication: `<author abbreviation>:<venue><year>`. For example a paper published at `ICSE` in `2005` by `Alice Change` and `Bob Delta` would have the key `CD:ICSE05`. In the following each key element is explained:
24+
- `<author abbreviation>`:
25+
- If the entry is a thesis: `<author abbreviation>` = `<last name of author>`. In case of a key conflict use `<author abbreviation>` = `<last name of author><first letter of first name of author>`
26+
- If entry has <=4 authors: `<author abbreviation>` = `<first letter of last name of author 1><first letter of last name of author 2>...`
27+
- If the entry has >4 authors: `<author abbreviation>` = `<first letter of last name of author 1><first letter of last name of author 2><first letter of last name of author 3>+`
28+
- `<venue>`: Each venue has an abbreviation (e.g., `ICSE`, `SoSym`, `ESECFSE`). These abbreviations are defined in `MYabrv.bib` and `MYshort.bib`. If a venue you encounter is not contained in these files, please add it (sorted in ascending alphabetic order). Use this abbreviation as the `<venue>` value.
29+
- `<year>`: Short version of the year the entry was published in. It has only two digits, ommitting the first two digits of a year number (i.e., `96` for 1996 and `05` for 2005). If you get old enough to find a redundancy caused by this two-digit abbreviation: congratulations.
30+
- In case that the generated key is conflicting with an existing key, add a suffix, such as `b`, `c`, ...
31+
- **If a journal does not have an official abbreviation** of letters only we still use our custom abbreviation for MYshort.bib. For example, the _Journal on Software Maintenance: Research and Practice_ should be abbreviated _J. Softw. Maint: Res. Pract._ but not by its variable name `JSMRP` we invented. Still, we abbreviate it in MYshort with `@String{JSMRP = "JSMRP"}` for consistency.
32+
- **If you detect an ill-formed key**, please update it. Add a corresponding `renamedFrom = {...},` containing the previous key, such that authors of papers using the old key can quickly find the updated key:
33+
```tex
34+
@inproceedings{KAK:ICSE08,
35+
renamedFrom = {KAK08},
36+
author = {Christian K\"{a}stner and Sven Apel and Martin Kuhlemann},
37+
title = {{Granularity in Software Product Lines}},
38+
booktitle = ICSE,
39+
...
40+
```
41+
42+
### Policies for Theses
43+
- **Keys** of theses are formatted according to the formatting rules described above.
44+
- **The month of a thesis entry** is the month of the defense (because publication of a thesis might happen much later).
45+
- **Publication status of theses** should be indicated in exactly one of the following three ways:
46+
- If the thesis is already published, add DOI and URL. The URL should directly point to the PDF.
47+
- If the thesis is not published and should not be published, add `comments = nottobepublished,`.
48+
- If the thesis is not published but should be published, add `note = toappear`.
49+
- **Add `type` for bachelor, master, and project thesis**. These theses should be specified as `@mastersthesis` as it is the only bibtex entry type for thesis (apart from `@phdthesis`). Distinguish between different types of theses by using `type = Bachelor`, `type = Master`, or `type = Project` respectively.
50+
- **For theses written in german** add `note = {In German}`.
51+
52+
## Custom Fields
53+
Use custom fileds to add addtional information for single entries. **Do not write comments inbetween entries.**
54+
- **comments**: Contains miscellaneous comments for this entry.
55+
- Common strings:
56+
- NotToBePublished (For Bachelor/Master theses)
57+
- Example: `comments = NotToBePublished,`
58+
59+
- **missing**: Documents which information for required fields are unavailable for this entry.
60+
- Common strings:
61+
- NoDOI
62+
- NoUrl
63+
- NoPages
64+
- NoMonth
65+
- NoPublisher
66+
- NoAddress
67+
- NoChapterNo
68+
- Example: `missing = NoDOI # NoURL # NoMonth # NoAddress,`
69+
70+
- **subsumes**: Contains all keys of entries, which are subsumed by this entry.
71+
- Example: `subsumes = {RBP+:TR22,RPTS:FORTE22,RPTS:TR22},`
72+
73+
- **subsumedby**: Contains key of the entry, which subsumes this entry.
74+
- Example: `subsumedBy = {RBP+:LMCS23},`
75+
76+
- **renamedFrom**: Contains previous keys of this entry.
77+
- Example: `renamedFrom = {AGK+:SPLC2020},`
78+
79+
## DON'Ts
80+
- **Edit `literature-cleaned.bib`**: This is a generated file. It is generated from literature cleaned with [MibTeX](https://github.com/SoftVarE-Group/MibTeX). After you changed `literature.bib`, you can update `literature-cleaned.bib` by running `clean.sh` / `clean.bat`.
81+
82+
- Commit changes **without running `./run sort` first**.
83+
84+
## Testing
85+
86+
Many problems with added (and some existing) entries can be detected automatically by running the script `test.sh`.
87+
This script does multiple checks:
88+
1. Creates literature-cleaned.bib using mibtex
89+
2. Compiles bib files with latex
90+
1. Using biblatex and biber to compile `literature.bib` and `MYshort.bib`
91+
2. Using biblatex and biber to compile `literature.bib` and `MYabrv.bib`
92+
3. Using natbib and bibtex to compile `literature.bib` and `MYshort.bib`
93+
4. Using natbib and bibtex to compile `literature-cleaned.bib` and `MYshort.bib`
94+
3. Runs python script `scripts/check_integrity.py`
95+
96+
The script display problems in the console output. However, the complete output of all called tools can be found in individual .log files in the directory `test`. This directory also contains the compiled pdf files, for further manual inspection.
97+
98+
### check_integrity.py
99+
100+
This script performs multiple checks for all entries in the file `literature.bib`.
101+
1. Tests that fields declared as string fields contain only string values.
102+
2. Creates bibtex strings for fields that are declared as string fields but do not contains string values and prints them to the console.
103+
3. Tests that for each entry *required*, *wanted* and *optional* exist or are declared as missing.
104+
4. Tests that the title of each entry is protected (uses `{{...}}`).
105+
5. Tests that the title of each entry is correctly capitalized (this may produce false optional results for some titles).
106+
6. Tests that the pages of each entry are formated correctly (use `--`).
107+
7. Tests that the names of authors of each entry follow the syntax `<last name>, <first name> and ...`.
108+
8. Tests that the key of each entry conforms to our naming scheme (may also produce false positive results).
109+
110+
All detected problems are written to the console grouped by entries.
111+
112+
The script can be configured using the following files
113+
- `scripts/test/config_check_integrity.yaml`: Declares which specific checks are enabled/disabled.
114+
- `scripts/test/config_field_types.yaml`: Declares for each entry type (e.g. inproceedings, article, ...) which fields are required (must be present), wanted (additional useful information), or optional (can be present, but are mostly ignored). Some fields are mutually exclusive, such as volume and number for inproceedings entries. This is defined by using sub lists in the config file.
115+
For example: ```
116+
- - volume
117+
- number
118+
```
119+
- `scripts/test/config_string.yaml`: Declares which fields should contain bibtex strings instead of literals.

0 commit comments

Comments
 (0)