Skip to content

Commit

Permalink
Security Force Monitor Research Handbook:
Browse files Browse the repository at this point in the history
- overhauled version of Research Handbook, including updated and harmonized fieldset and deeper field level documentation.
- Handbook converted to .rst format for use in Sphinx.
- Now published on ReadTheDocs instead of Gitbook.
  • Loading branch information
tlongers committed Dec 3, 2019
0 parents commit ff7979b
Show file tree
Hide file tree
Showing 303 changed files with 52,181 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# OSX

## General
.DS_Store
.AppleDouble
.LSOverride

## Icon must end with two \r
Icon

## Thumbnails
._*

## Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# gpg

secring.*


.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

# Vim

## Swap
[._]*.s[a-v][a-z]
!*.svg # comment out if you don't need vector files
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]

## Session
Session.vim
Sessionx.vim

## Temporary
.netrwhist
*~
## Auto-generated tag files
tags
## Persistent undo
[._]*.un~
19 changes: 19 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file added build/doctrees/README.doctree
Binary file not shown.
Binary file added build/doctrees/datamodel.doctree
Binary file not shown.
Binary file added build/doctrees/environment.pickle
Binary file not shown.
Binary file added build/doctrees/eventrec.doctree
Binary file not shown.
Binary file added build/doctrees/events.doctree
Binary file not shown.
Binary file added build/doctrees/generalfunctions.doctree
Binary file not shown.
Binary file added build/doctrees/geography.doctree
Binary file not shown.
Binary file added build/doctrees/help.doctree
Binary file not shown.
Binary file added build/doctrees/index.doctree
Binary file not shown.
Binary file added build/doctrees/introduction.doctree
Binary file not shown.
Binary file added build/doctrees/license.doctree
Binary file not shown.
Binary file added build/doctrees/methodology.doctree
Binary file not shown.
Binary file added build/doctrees/organizations.doctree
Binary file not shown.
Binary file added build/doctrees/overview.doctree
Binary file not shown.
Binary file added build/doctrees/persons.doctree
Binary file not shown.
Binary file added build/doctrees/personsrec.doctree
Binary file not shown.
Binary file added build/doctrees/sources_confidence.doctree
Binary file not shown.
Binary file added build/doctrees/tabletest.doctree
Binary file not shown.
Binary file added build/doctrees/tutorials.doctree
Binary file not shown.
Binary file added build/doctrees/unitrec.doctree
Binary file not shown.
Binary file added build/doctrees/whowasincommand.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/datamodel.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/environment.pickle
Binary file not shown.
Binary file added build/gettext/.doctrees/eventrec.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/events.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/generalfunctions.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/index.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/methodology.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/organizations.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/overview.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/persons.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/personsrec.doctree
Binary file not shown.
Binary file not shown.
Binary file added build/gettext/.doctrees/tutorials.doctree
Binary file not shown.
Binary file added build/gettext/.doctrees/unitrec.doctree
Binary file not shown.
53 changes: 53 additions & 0 deletions build/gettext/datamodel.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2019, Security Force Monitor
# This file is distributed under the same license as the SFM Research Handbook package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: SFM Research Handbook \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2019-09-26 12:40+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: ../../source/datamodel.rst:2
# be6eef43574240e7b36b8cd13257bddd
msgid "What data does the Monitor collect?"
msgstr ""

#: ../../source/datamodel.rst:4
# e9242973fff846948b21d6efa6e3d11d
msgid "Security Force Monitor researches and creates data about three things (or \"entities\") related to security forces around the world:"
msgstr ""

#: ../../source/datamodel.rst:6
# 92ae6ed36e124276a9eacffbc109d9b1
msgid ":ref:`Organizations` are official state or state-sanctioned organizations responsible for the internal or external security for a country, including the police, army, navy, air force and other security forces. Organizations refer to any any part of the hierarchy of a security force, ranging from a national defense ministry, to a police unit based in a small town. Organizations can also be groupings of organizations that occur, such as \"operations\", \"joint task forces\" or peacekeeping missions. The Monitor collects data about an organization's name, aliases, location, geographical areas of operation and relationships with other organizations."
msgstr ""

#: ../../source/datamodel.rst:7
# 1c1ed7e3e1a544828173e8f20a3e437a
msgid ":ref:`Persons` are natural persons who are affiliated with, or hold positions of command over a specific organization at a particular point in time. The Monitor creates a dossier for each person, which includes their name, aliases, rank, title, role and the different organizations which they are affiliated with."
msgstr ""

#: ../../source/datamodel.rst:8
# 81ac7d86ce9442119315f676edd5137f
msgid "Incidents are publicly-documented allegations of human rights violations committed by security forces. These include extrajudicial killings, rape, torture and other forms of violence. The Monitor does not make allegations itself, but rather complies allegations made by governmental bodies, human rights organizations and other civil society actors. For each incident, the Monitor includes a description from the source, date(s), specific location(s), its perpetrators and the type of human rights violation."
msgstr ""

#: ../../source/datamodel.rst:10
# bfc59af447f54855a1b0dfeeec06c7ec
msgid "Every piece of data collected by the Monitor is individually sourced and each data point about Persons and Organizations are assigned a confidence rating. The Research Handbook section on sources and confidence provides more guidance about this aspect of the data."
msgstr ""

#: ../../source/datamodel.rst:12
# bc55eeeddcb0498b80552290727cbd3c
msgid "Detailed guidance about the fields used by the Monitor to record data about ``Organizations``, ``Persons`` and ``Incidents`` is provided in the remainder of this document."
msgstr ""

210 changes: 210 additions & 0 deletions build/gettext/eventrec.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2019, Security Force Monitor
# This file is distributed under the same license as the SFM Research Handbook package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: SFM Research Handbook \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2019-09-26 12:40+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: ../../source/eventrec.rst:2
# b60f37736e69443f8d463bd65bced7dc
msgid "Incident Records on WhoWasInCommand"
msgstr ""

#: ../../source/eventrec.rst:4
# f6a1671084834636ac650655d9cb648a
msgid "This page contains an overview of the data that visitors to WhoWasInCommand will find in an incident record."
msgstr ""

#: ../../source/eventrec.rst:6
# fc62e135a21047b1b6cce141b1476982
msgid "This includes the different sections of the incident record, the data fields that are used to create it and links to more information about each field."
msgstr ""

#: ../../source/eventrec.rst:9
# bbc44b0301a4478d91de95d680fc54d3
msgid "Incident title area"
msgstr ""

#: ../../source/eventrec.rst:14
# 609747fc3d2d4824b51e55dd76ed5afa
msgid "This section contains key information about the incident. It also contains links to download and print actions for the displayed record. Hover over any value in the title area to display a little coloured circle; clicking on this will display the sources and confidence rating for we have assigned to each value."
msgstr ""

#: ../../source/eventrec.rst:16
# 87451fc732974906bcb2c166e9a77d3d
msgid "**Fields used in incident title area**"
msgstr ""

#: ../../source/eventrec.rst:18
# 237f018af1ba4fd9a68006d45ef133f3
msgid "The following fields are used in the incident title area section:"
msgstr ""

#: ../../source/eventrec.rst:20
# d916c57fb7754cfb8b911f99026bdfa5
msgid ":ref:`Event: Start date`"
msgstr ""

#: ../../source/eventrec.rst:21
# d15838348fed43e8a27af8b7e102faee
msgid ":ref:`Event: End date`"
msgstr ""

#: ../../source/eventrec.rst:22
#: ../../source/eventrec.rst:50
# 733b5eb4edbf450f880add6e0f251dd5
# 46d0f74dcd3a4660b73882b0849df64d
msgid ":ref:`Event: Country`"
msgstr ""

#: ../../source/eventrec.rst:23
# 91432d013d0b4684a8a22b754e5e92e5
msgid ":ref:`Event: Violation type`"
msgstr ""

#: ../../source/eventrec.rst:26
# c49092219f7e4f518005d0f8f9ba8466
msgid "Incident content sidebar"
msgstr ""

#: ../../source/eventrec.rst:31
# 092c1600985b4d2d9b2c7092f98cc41c
msgid "The content sidebar is a navigation aid. It provides quick links to different sections of the record. The items inside the content sidebar indicate what sort of data is available about this incident. For example if \"Perpetrator organizations\" is not listed in the content sidebar, then there is no data available about alleged perpetrators of the incident."
msgstr ""

#: ../../source/eventrec.rst:34
# 47afc8764cc644979f6859df3a22db89
msgid "Incident location"
msgstr ""

#: ../../source/eventrec.rst:39
# d32e6dc46b384626952dfc4cfb31d481
msgid "This section contains an interactive map and some text that describe the location where sources indicate that an incident occured. Click on the pins placed in the map to display the name of a location. Grab the map to drag/pan it around. Swipe or use the ``+`` and ``-`` controls on the map to zoom in or zoom out. Hover over the text description of the location and a little coloured circle will appear. Click on this to view the sources and confidence rating we have assigned to that value."
msgstr ""

#: ../../source/eventrec.rst:41
# 1667115072c648d38cfd8c7966ed1ced
msgid "**Fields used in incident location section**"
msgstr ""

#: ../../source/eventrec.rst:43
# 5fbe9c17fd8e4f488c419ecb843bce33
msgid ":ref:`Event: Location`"
msgstr ""

#: ../../source/eventrec.rst:44
# 97e1d568d60f4ca291f0f93414e8f04b
msgid ":ref:`Event: Exact location (Longitude or OSM object Name)`"
msgstr ""

#: ../../source/eventrec.rst:45
# 3b0a98513f76437f8a7ce99b0a4f9726
msgid ":ref:`Event: Exact location (Latitude or OSM object ID number)`"
msgstr ""

#: ../../source/eventrec.rst:46
# b333af083c71487d9ab73220063a74d4
msgid ":ref:`Event: Settlement (OSM object Name)`"
msgstr ""

#: ../../source/eventrec.rst:47
# 587bd243ed7a4a32a1079110f14461b7
msgid ":ref:`Event: Settlement (OSM object ID Number)`"
msgstr ""

#: ../../source/eventrec.rst:48
# b44b1014026c413591650ccf8e7804f2
msgid ":ref:`Event: Top Administrative Area (OSM object name)`"
msgstr ""

#: ../../source/eventrec.rst:49
# 71048112395b4b9b9f66154b55ff75d9
msgid ":ref:`Event: Top Administrative Area (OSM object ID number)`"
msgstr ""

#: ../../source/eventrec.rst:53
# 22caaed1dcb14cbb974ab08af927abf8
msgid "Incident description"
msgstr ""

#: ../../source/eventrec.rst:58
# 5acb5ae190fa428d8c4920fba255ef87
msgid "This section contains a direct quotation from the civil society, governmental or other source that describes the incident. As with all tables in person, unit and incident records on WhoWasInCommand, hovering over or tapping any value in the table will cause a little coloured circle to appear. Clicking or tapping again on this will show the sources and confidence ratings we have assigned to that value."
msgstr ""

#: ../../source/eventrec.rst:60
# b7612aa83bc04107977efbf241bfd3f1
msgid "**Fields used in incident description section**"
msgstr ""

#: ../../source/eventrec.rst:62
# ff020e273b9247639d2ed4146a56c08c
msgid "The following field is used in the incident description section:"
msgstr ""

#: ../../source/eventrec.rst:64
# fae90bd820ad415fb87decbfdb80576b
msgid ":ref:`Event: Description`"
msgstr ""

#: ../../source/eventrec.rst:67
# c2d1641e162349c19d7c8acac6ce603e
msgid "Perpetrator organizations"
msgstr ""

#: ../../source/eventrec.rst:72
# e50a9ebea4f24254845419be7e163472
msgid "This section contains a table listing the organization(s) that sources allege committed the human rights violation(s) described in the incident. As with all tables in person, unit and incident records on WhoWasInCommand, hovering over or tapping any value in the table will cause a little coloured circle to appear. Clicking or tapping again on this will show the sources and confidence ratings we have assigned to that value."
msgstr ""

#: ../../source/eventrec.rst:74
# 33eaffba0f3847388ffa660071a67068
msgid "**Fields used in perpetrator organizations section**"
msgstr ""

#: ../../source/eventrec.rst:76
# a1c3379d0a1043e098d9c7cf6ca0085a
msgid "The following fields are used in the perpetrator organizations section:"
msgstr ""

#: ../../source/eventrec.rst:78
# 63b09312eda7446cb8b28a4e8a99f44d
msgid ":ref:`Event: Perpetrator organization`"
msgstr ""

#: ../../source/eventrec.rst:79
# d2bfe4858d8644afb0ebeb93bbcf8958
msgid ":ref:`Organization: Name`"
msgstr ""

#: ../../source/eventrec.rst:80
# 5ec4504ee92f4a07b073884bab6fa331
msgid ":ref:`Organization: Aliases`"
msgstr ""

#: ../../source/eventrec.rst:81
# 245f8c1e57e14892a96bd0bb655fe1b3
msgid ":ref:`Organization: Classification`"
msgstr ""

#: ../../source/eventrec.rst:84
# 48406b318bd348f2a6d8a4c3f2082857
msgid "Incident Changelog"
msgstr ""

#: ../../source/eventrec.rst:89
# 7657799bd59d41efb9550e71ee1b7f02
msgid "The data displayed in any record on WhoWasInCommand is always the most up to date version. The changelog section shows when the data included in this record were first added and subsequently updated. This data is generated by the software that powers WhoWasInCommand whenever a new data import is run. Clicking on the name of the field will open a box showing all the changes that were made to a datapoint, including the time the change was made and the source used to evidence the change."
msgstr ""

0 comments on commit ff7979b

Please sign in to comment.