<commit_before>\documentclass[a4paper,11pt]{article}
\usepackage[utf8]{inputenc}
\usepackage[english]{babel}
\usepackage[usenames,dvipsnames]{color}
\usepackage{verbatim}
\usepackage{graphicx}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{subfig}
\usepackage{ctable}
\usepackage{hyperref}

\newcommand{\term}[1]{{\bf #1}}

%\author{<NAME>}
\title{DustyTuba Bluetooth Library Documentation}
%\date{Torsdag d. 7. april 2011}

\begin{document}
%\setcounter{page}{0}
\maketitle

\begin{abstract}
This document outlines the three basic steps needed to incorporate the DustyTuba Bluetooth Library in your Android application
\end{abstract}

%\tableofcontents

%\clearpage

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{Step one - Include necessary files}
Firstly, you need to copy the three folders (\verb+libs+, \verb+res+ and \verb+src+)-folder included in the archive to the root folder of the Android project in which you want to use the library.

Secondly, you must include the libraries in the \verb+libs+ folder into your project. In Eclipse, this can be done by right-clicking your project and selecting ``Properties'', then selecting ``Java Build Path'', and in the tab ``Libraries'' clicking the ``Add JARs...'' button and selecting the two included {\tt .jar} files in the \verb+libs+ folder.

As is also described in the Bump\texttrademark{} documentation, you must import your project's \verb+R+ class in the {\tt com.bumptech.bumpapi.BumpResources} source file -- i.e. if your project has package name {\tt com.example.test}, you must insert the following line into the {\tt BumpResources.java} file:

\begin{verbatim}
import com.example.test.R;
\end{verbatim}

\clearpage

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{Step two - Modify manifest}
Now you must expand the Android manifest to include the activities provided and to use the permissions needed. The activities you must declare goes in the \verb+<application>+-element and are the following:

\footnotesize
\begin{verbatim}
<activity android:name="dk.hotmovinglobster.dustytuba.id.GenericIPActivity" />
<activity android:name="dk.hotmovinglobster.dustytuba.id.FakeIPActivity" />
<activity android:name="dk.hotmovinglobster.dustytuba.id.ManualIPActivity" />
<activity android:name="dk.hotmovinglobster.dustytuba.id.BumpIPActivity"
    android:configChanges="keyboardHidden|orientation"/>
<activity android:name="com.bumptech.bumpapi.BumpAPI"
    android:configChanges="keyboardHidden|orientation"
    android:theme="@style/BumpDialog" />
<activity android:name="com.bumptech.bumpapi.EditTextActivity"
    android:configChanges="keyboardHidden|orientation"
    android:theme="@style/BumpDialog" />
\end{verbatim}
\normalsize

The permissions to be declared goes in the main \verb+<manifest>+-element and are the following:

\footnotesize
\begin{verbatim}
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
\end{verbatim}
\normalsize

See appendix \ref{sample-manifest} for a complete sample manifest file.

\clearpage

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{Step three - Call the library}
\label{stepthree}
In order to call the library, you will use the \verb+BtAPI.getIntent()+ method (see section \ref{getIntent}) to generate an \verb+Intent+ which must be passed on to Android's \verb+startActivityForResult()+ method.
<commit_msg>Documentation of Manifest updated w/ comment and additional permissions and activities required<commit_after>\documentclass[a4paper,11pt]{article}
\usepackage[utf8]{inputenc}
\usepackage[english]{babel}
\usepackage[usenames,dvipsnames]{color}
\usepackage{verbatim}
\usepackage{graphicx}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{subfig}
\usepackage{ctable}
\usepackage{hyperref}

\newcommand{\term}[1]{{\bf #1}}

%\author{<NAME>}
\title{DustyTuba Bluetooth Library Documentation}
%\date{Torsdag d. 7. april 2011}

\begin{document}
%\setcounter{page}{0}
\maketitle

\begin{abstract}
This document outlines the three basic steps needed to incorporate the DustyTuba Bluetooth Library in your Android application
\end{abstract}

%\tableofcontents

%\clearpage

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{Step one - Include necessary files}
Firstly, you need to copy the three folders (\verb+libs+, \verb+res+ and \verb+src+)-folder included in the archive to the root folder of the Android project in which you want to use the library.

Secondly, you must include the libraries in the \verb+libs+ folder into your project. In Eclipse, this can be done by right-clicking your project and selecting ``Properties'', then selecting ``Java Build Path'', and in the tab ``Libraries'' clicking the ``Add JARs...'' button and selecting the two included {\tt .jar} files in the \verb+libs+ folder.

As is also described in the Bump\texttrademark{} documentation, you must import your project's \verb+R+ class in the {\tt com.bumptech.bumpapi.BumpResources} source file -- i.e. if your project has package name {\tt com.example.test}, you must insert the following line into the {\tt BumpResources.java} file:

\begin{verbatim}
import com.example.test.R;
\end{verbatim}

\clearpage

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{Step two - Modify manifest}
Now you must expand the Android manifest to include the activities provided and to use the permissions needed. The activities you must declare goes in the \verb+<application>+-element and are the following:

\footnotesize
\begin{verbatim}
<!-- Reserved for future use: May replace all other activities when fully implemented -->
<activity android:name="dk.hotmovinglobster.dustytuba.id.GenericIPActivity" />
<!-- Mandatory for API -->
<activity android:name="dk.hotmovinglobster.dustytuba.bt.BluetoothConnector"></activity>
<!-- Optional: Identity Providers, include one or more -->
<activity android:name="dk.hotmovinglobster.dustytuba.id.FakeIPActivity" />
<activity android:name="dk.hotmovinglobster.dustytuba.id.ManualIPActivity" />
<activity android:name="dk.hotmovinglobster.dustytuba.id.BumpIPActivity"
    android:configChanges="keyboardHidden|orientation"/>
<!-- Optional: Additional activities required by BumpIPActivity -->
<activity android:name="com.bumptech.bumpapi.BumpAPI"
    android:configChanges="keyboardHidden|orientation"
    android:theme="@style/BumpDialog" />
<activity android:name="com.bumptech.bumpapi.EditTextActivity"
    android:configChanges="keyboardHidden|orientation"
    android:theme="@style/BumpDialog" />
\end{verbatim}
\normalsize

The permissions to be declared goes in the main \verb+<manifest>+-element and are the following:

\footnotesize
\begin{verbatim}
<!-- Mandatory for API -->
<uses-permission android:name="android.permission.BLUETOOTH" />
<!-- Optional: BLUETOOTH_ADMIN needed for cancel discovery (powersave) -->
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<!-- Optional: Additional permissions required by BumpIPActivity -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
\end{verbatim}
\normalsize

See appendix \ref{sample-manifest} for a complete sample manifest file.

\clearpage

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{Step three - Call the library}
\label{stepthree}
In order to call the library, you will use the \verb+BtAPI.getIntent()+ method (see section \ref{getIntent}) to generate an \verb+Intent+ which must be passed on to Android's \verb+startActivityForResult()+ method.

{'fraction_non_alphanumeric': 0.19334743770568877, 'fraction_numerical': 0.0028208744710860366, 'mean_word_length': 6.360726643598616, 'pattern_counts': {'":': 0, '<': 42, '<?xml version=': 0, '>': 42, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6695125', 'n_tokens_mistral': 2499, 'n_tokens_neox': 2335, 'n_words': 685}