Skip to content

Commit

Permalink
merge all docs back into rulebook
Browse files Browse the repository at this point in the history
  • Loading branch information
LeroyR committed Dec 3, 2024
1 parent 7687339 commit c393f5c
Show file tree
Hide file tree
Showing 17 changed files with 33 additions and 57 deletions.
11 changes: 3 additions & 8 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
strategy:
fail-fast: false
matrix:
document: [organization, rulebook, scoresheets]
document: [rulebook, scoresheets]

steps:
- uses: actions/checkout@v4
Expand All @@ -36,6 +36,7 @@ jobs:
- name: LaTeX compilation
run:
TERM=xterm make ${{ matrix.document }}

- name: Upload build result
uses: actions/upload-artifact@v4
with:
Expand All @@ -53,11 +54,6 @@ jobs:
with:
ref: gh-pages

- name: Download organization
uses: actions/download-artifact@v4
with:
name: organization
path: ${{ runner.temp }}/organization
- name: Download rulebook
uses: actions/download-artifact@v4
with:
Expand All @@ -68,20 +64,19 @@ jobs:
with:
name: scoresheets
path: ${{ runner.temp }}/scoresheets

- name: Preparations for GitHub Pages
if: github.ref_name == github.event.repository.default_branch
env:
ARTIFACTS_PATH: ${{ runner.temp }}
run: |
# Make sure directories exist
cd "${GITHUB_WORKSPACE}"
mkdir -p organization
mkdir -p rulebook
mkdir -p scoresheets
FILENAME=${GITHUB_REF_NAME}
# Strip out any extra slashes in the rest
FILENAME=${FILENAME//\//\_}.pdf
mv ${ARTIFACTS_PATH}/organization/organization.pdf organization/${FILENAME}
mv ${ARTIFACTS_PATH}/rulebook/rulebook.pdf rulebook/${FILENAME}
mv ${ARTIFACTS_PATH}/scoresheets/scoresheets.pdf scoresheets/${FILENAME}
- name: Commit and push to GitHub Pages
Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,13 @@ jobs:
- name: Allow for file ownership conflicts with Docker and GitHub Actions
run: git config --global --add safe.directory '*'

- name: LaTeX compilation Organization
run:
TERM=xterm make organization
- name: LaTeX compilation Rulebook
run:
TERM=xterm make rulebook
- name: LaTeX compilation Score sheets
run:
TERM=xterm make scoresheets

- name: Create Release
id: create-release
uses: softprops/action-gh-release@v2
Expand All @@ -48,6 +46,5 @@ jobs:
generate_release_notes: false
token: ${{ secrets.GITHUB_TOKEN }}
files: |
.build/organization.pdf
.build/rulebook.pdf
.build/scoresheets.pdf
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ All notable changes to this project will be documented in this file.
## Rulebook [Current Draft]

* [#922](https://github.com/RoboCupAtHome/RuleBook/pull/922): Remove Bonus for perceived social intelligence as the survey was too hard to conduct in Robocup settings.
* [#917](https://github.com/RoboCupAtHome/RuleBook/pull/917) revert: split document into Rulebook and Organization document
* [#887](https://github.com/RoboCupAtHome/RuleBook/pull/887): Remove Social Standard Platform League.
* The League does have a low number of participants.
* Former SSPL Teams can participate in the OPL and thus modify the Robot.
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ RuleBook for RoboCup @Home 2025
### PDF Downloads

[Rulebook](https://robocupathome.github.io/RuleBook/rulebook/master.pdf)
[Organization guidelines](https://robocupathome.github.io/RuleBook/organization/master.pdf)
[Score sheets](https://robocupathome.github.io/RuleBook/scoresheets/master.pdf)

The current version for 2025 is **draft**
Expand Down
File renamed without changes.
11 changes: 0 additions & 11 deletions citation_organization.bib

This file was deleted.

File renamed without changes.
7 changes: 3 additions & 4 deletions documents/rulebook.tex
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,17 @@

\input{pages/rulebook/Introduction}

%\input{roadmap/CompetitionConcepts}
\input{pages/roadmap/CompetitionConcepts}

\input{pages/rulebook/GeneralRules}

%\input{Setup}
\input{pages/organization/Setup}



%%% STAGE I
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Tests in Stage I}
\label{chap:stage_I}
\chapter{Tests in Stage I}\label{chap:stage_I}

\testtocentry{test:carry-my-luggage}
\testtocentry{test:gpsr}
Expand Down
2 changes: 1 addition & 1 deletion pages/general_rules/ContinueRules.tex
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ \subsection{Bypassing Automatic Speech Recognition}
\item \textbf{QR Codes:} A reduction of 30\% of the maximum attainable score is applied when a QR code is used to instruct the robot.

\item \textbf{Alternative Input Method:} A reduction of up to 30\% of the maximum attainable score is applied when a \iterm{alternative HRI interface}, is used to instruct the robot.
Alternative HRI interfaces (see~\refsec{rule:asralternative}) must be previously approved by the TC during the Robot Inspection (see \Organisation).
Alternative HRI interfaces (see~\refsec{rule:asralternative}) must be previously approved by the TC during the Robot Inspection (see~\refsec{sec:robot_inspection}).
\end{enumerate}


Expand Down
2 changes: 1 addition & 1 deletion pages/general_rules/ExternalDevices.tex
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ \section{External devices}
\subsection{On-site External Computing}

Computing resources that are not physically attached to the robot are considered \ExternalComputing{} resources.
The use of up to five \ExternalComputing{} resources is allowed, but only in the \ArenaNetwork{} (see \Rulebook) and with a prior approval of the TC.
The use of up to five \ExternalComputing{} resources is allowed, but only in the \ArenaNetwork{} (see~\refsec{rule:scenario_wifi}) and with a prior approval of the TC.
Teams must inform the TC about the use of any \ExternalComputing{} at least one month before the competition.
Note, however, that robots must be able to operate safely even if \ExternalComputing{} is unavailable.

Expand Down
10 changes: 3 additions & 7 deletions pages/general_rules/Organization.tex
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Organization of the Competition}
\label{sec:procedure_during_competition}
\section{Organization of the Competition}\label{sec:procedure_during_competition}

\subsection{Stage System}\label{rule:stages}

Expand Down Expand Up @@ -120,18 +119,15 @@ \subsection{Schedule}
\label{tbl:schedule}
\end{table}

\noindent Note that the actual allocation of blocks will be announced by the OC during the \SetupDays{} (see Table \ref{tbl:schedule}).
\noindent Note that the actual allocation of blocks will be announced by the OC during the \SetupDays{} (see Table~\ref{tbl:schedule}).

\subsection{Scoring System}
\label{rule:score_system}
\subsection{Scoring System}\label{rule:score_system}

Each task has a main objective and a set of bonus scores.
To score in a test, a team must successfully accomplish the main objective of the task; bonuses are not awarded otherwise.

The scoring system has the following constrains:
\begin{enumerate}
\item \textbf{\SONE:} The maximum total score per task in \SONE{} is \scoring{1000 points}.
\item \textbf{\STWO:} The maximum total score per task in \STWO{} is \scoring{2000 points}.
\item \textbf{\FINAL:} The final score is normalized.
\item \textbf{Minimum score:} The minimum total score per test in \SONE{} and \STWO{} is \scoring{0 points}.
In principle, teams cannot receive negative points, except if they receive penalties.
Expand Down
6 changes: 3 additions & 3 deletions pages/general_rules/Scenario.tex
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ \subsection{Objects}
Some tests in the RoboCup@Home league involve recognizing and manipulating objects (see Figure~\reffig{fig:scenario_objects}).
The TC will compile a list of at least \NumObjects objects for this purpose; the list will contain a picture of the each object, as well as its official name and \ObjectCategory{} (for instance, an \textit{Apple} belongs to the \textit{Fruits} category).
Most objects are likely to be lightweight and easy to grasp with one hand.
Every \ObjectCategory{} has an assigned \PredefinedLocation, where objects of that category can usually be found during tests (for example, an \textit{Fruits} can be found on the \textit{Kitchen Table}); assignments are announced during the \SetupDays{} (see \Organisation).
Every \ObjectCategory{} has an assigned \PredefinedLocation, where objects of that category can usually be found during tests (for example, an \textit{Fruits} can be found on the \textit{Kitchen Table}); assignments are announced during the \SetupDays{} (see~\refsec{chap:setup_and_preparation}).

Objects are provided at the competition for training.
Teams may keep at most five training objects at a time and for at most one hour.
Expand Down Expand Up @@ -177,15 +177,15 @@ \subsection{Predefined Rooms and Locations}

Some tests in the RoboCup@Home league involve a \PredefinedLocation{} where people or objects can be found.
There will also be at least two \Term{doors}{Arena doors}, named an \Entrance{} and an \Exit, which lead in and out of the \Arena{}, respectively.
Room names, predefined locations, and location classes are announced during the \SetupDays{} (see \Organisation).
Room names, predefined locations, and location classes are announced during the \SetupDays{} (see~\refsec{chap:setup_and_preparation}).

\subsection{Predefined Person Names}
\label{rule:scenario_names}

Some tests in the RoboCup@Home league involve memorizing a person's name.
All people in the \Arena{} have an assigned \PredefinedName{} chosen by the TC.
The list of names contains \SI{25}{\percent} male, \SI{25}{\percent} female, and \SI{50}{\percent} gender-neutral names taken from the list of most commonly used names in the United States.
Predefined names are announced during the \SetupDays{} (see \Organisation).
Predefined names are announced during the \SetupDays{} (see~\refsec{chap:setup_and_preparation}).

\subsection{Wireless network}
\label{rule:scenario_wifi}
Expand Down
2 changes: 1 addition & 1 deletion pages/introduction/Infrastructure.tex
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ \section{Infrastructure}
\label{sec:introduction:mailinglist}
The official \AtHome{} mailing list can be found at\\
\href{mailto:[email protected]}{\small\texttt{[email protected]}}.
You can subscribe to the mailing list at: {\small\url{http://lists.robocup.org/cgi-bin/mailman/listinfo/robocup-athome}}
You can subscribe to the mailing list at: {\small\url{https://lists.robocup.org/mm/lists/robocup-athome.lists.robocup.org/}}

\paragraph{RoboCup@Home Web Page}
\label{sec:introduction:webpage}
Expand Down
6 changes: 3 additions & 3 deletions pages/organization/Setup.tex
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ \chapter{Setup and Preparation}
\label{chap:setup_and_preparation}
Prior to the RoboCup@Home competition, all arriving teams will have an opportunity to set up their robots and prepare for the competition in a \iterm{Setup \& Preparation} phase. This phase is scheduled to start on the first day of the competition, namely when the venue opens and the teams arrive. During the \SetupDays, teams can assemble and test their robots. On the last setup day, a \WelcomeReception{} will be held. To foster the knowledge exchange between teams a conference-like \PS{} takes place during the reception. Additionally, all teams have to get their robots inspected by members of the TC to be allowed to participate in the competition.

\paragraph{Regular tests are not conducted during the setup \& preparation phase.} The competition starts with \SONE{} (see \Rulebook).
\paragraph{Regular tests are not conducted during the setup \& preparation phase.} The competition starts with \SONE{} (see~\refsec{chap:stage_I}).

\begin{table}[h]
\newcolumntype{C}[1]{>{\centering\let\newline\\\arraybackslash\hspace{0pt}}m{#1}}
Expand Down Expand Up @@ -39,7 +39,7 @@ \section{General Setup}
\item \textbf{Tables:} The local organization will set up and randomly assign team tables.
\item \textbf{Groups:} Depending on the number of teams, the \OC{} may form multiple groups of teams (usually two) for the first (and second stage). The OC will assign teams to groups and announce the assignment to the teams.
\item \textbf{\Arena{}:} The \Arena{} is available to all teams during the \iterm{Setup \& Preparation}. The OC may schedule special test or mapping slots in which \Arena{} access is limited to one or more teams exclusively (all teams get slots). Note, however, that the \Arena{} may not yet be complete and that the last work is conducted in the \Arena{} during the \SetupDays.
\item \textbf{Objects:} The delegation of EC, TC, OC and local organizers will buy the objects (see \Rulebook). Note, however, that the objects may not be available at all times and not from the beginning of the \iterm{Setup \& Preparation}.
\item \textbf{Objects:} The delegation of EC, TC, OC and local organizers will buy the objects (see~\refsec{rule:scenario_objects}). Note, however, that the objects may not be available at all times and not from the beginning of the \iterm{Setup \& Preparation}.
\end{enumerate}

\section{Welcome Reception}
Expand Down Expand Up @@ -113,7 +113,7 @@ \section{Robot Inspection}
\item voice of the robot (it must be loud and clear)
\item custom containers (bowl, tray, etc.)
\item external devices (including wireless network), if any
\item Alternative human-robot interfaces (see \Rulebook).
\item Alternative human-robot interfaces (see~\refsec{rule:asralternative}).
\item \textbi{Standard Platform robots}
\begin{itemize}
\item no modifications have been made
Expand Down
14 changes: 7 additions & 7 deletions pages/rulebook/GeneralRules.tex
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,24 @@ \chapter{General Rules and Regulations}
Every rule in this section can be considered to implicitly include the term \emph{\enquote{unless stated otherwise}}.
This means that additional or contrary rules, in particular with respect to the specification of tests, have a higher priority than those mentioned in the general rules and regulations.

%\input{pages/general_rules/TeamRegistration}
\input{pages/general_rules/TeamRegistration}

%\input{pages/general_rules/vizbox}
\input{pages/general_rules/vizbox}

\input{pages/general_rules/Scenario}

%\input{pages/general_rules/Robots}
\input{pages/general_rules/Robots}

%\input{pages/general_rules/ExternalDevices}
\input{pages/general_rules/ExternalDevices}

%\input{pages/general_rules/Organization}
\input{pages/general_rules/Organization}

%\input{pages/general_rules/Procedure}
\input{pages/general_rules/Procedure}

\input{pages/general_rules/ContinueRules}
\input{pages/general_rules/PenaltiesBonuses}

%\input{pages/general_rules/OpenChallenge}
\input{pages/general_rules/OpenChallenge}

%\input{pages/general_rules/ManipulationChallenge}
% Local Variables:
Expand Down
8 changes: 4 additions & 4 deletions pages/rulebook/Introduction.tex
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ \section{RoboCup@Home}
The focus is on, but is not limited to, the following domains: human-robot interaction and cooperation, navigation and mapping in dynamic environments, computer vision and object recognition under natural light conditions, object manipulation, adaptive behaviors, behavior integration, ambient intelligence, standardization and system integration.
The competition is co-located with the RoboCup symposium.

%\input{pages/introduction/Organization}
\input{pages/introduction/Organization}

%\input{pages/introduction/Infrastructure}
\input{pages/introduction/Infrastructure}

%\input{pages/introduction/Leagues}
\input{pages/introduction/Leagues}

\input{pages/introduction/Competition}

%\input{pages/introduction/Awards}
\input{pages/introduction/Awards}

% Local Variables:
% TeX-master: "Rulebook"
Expand Down
4 changes: 2 additions & 2 deletions pages/rulebook/about.tex
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section*{About this rulebook}
This is the official rulebook of the RoboCup@Home competition \YEAR. It contains the tests performed by the robots and the scoring associated with it. But excludes the organisational details, which can be found in the \Organisation.
This is the official rulebook of the RoboCup@Home competition \YEAR.
The rulebook has been written by the \YEAR ~RoboCup@Home Technical Committee.

\section*{How to cite this rulebook}
Expand All @@ -23,7 +23,7 @@ \section*{How to cite this rulebook}
\begin{center}
\begin{minipage}{0.8\textwidth}
\footnotesize%
\verbatiminput{citation_rulebook.bib}
\verbatiminput{citation.bib}
\end{minipage}
\end{center}

Expand Down

0 comments on commit c393f5c

Please sign in to comment.