Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RTD 2025-01 Updates #2520

Merged
merged 12 commits into from
Jan 26, 2025
6 changes: 1 addition & 5 deletions docs/Coding/ai.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>

.. Custom Interpretive Text Roles for longturn.net/Freeciv21
.. role:: unit
.. role:: improvement
.. role:: wonder
.. role:: advance
.. include:: /global-include.rst

Artificial Intelligence (AI)
****************************
Expand Down
3 changes: 3 additions & 0 deletions docs/Coding/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>

.. include:: /global-include.rst

Architecture
************

Expand Down Expand Up @@ -62,5 +64,6 @@ structure of the repository:
:file:`utility` Utility classes and functions not found in Qt or other dependencies.
==================== ==========


.. note::
Some folders do not follow this structure. Their contents should eventually be moved.
2 changes: 2 additions & 0 deletions docs/Coding/attributes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>

.. include:: /global-include.rst

Attribute Blocks
****************

Expand Down
3 changes: 2 additions & 1 deletion docs/Coding/guidelines.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
..
.. SPDX-License-Identifier: GPL-3.0-or-later
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>

.. include:: /global-include.rst

Coding Guidelines
*****************

Expand Down
6 changes: 1 addition & 5 deletions docs/Coding/hacking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@
.. SPDX-FileCopyrightText: NIKEA-SOFT
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>

.. Custom Interpretive Text Roles for longturn.net/Freeciv21
.. role:: unit
.. role:: improvement
.. role:: wonder
.. role:: advance
.. include:: /global-include.rst

Freeciv21 Hacker's Guide
************************
Expand Down
12 changes: 7 additions & 5 deletions docs/Coding/internationalization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>

.. include:: /global-include.rst

Internationalization
********************

Expand All @@ -23,7 +25,7 @@ Paying attention to these three points is sufficient to get internationalization
of the cases.

Translating Text
----------------
================

Translating user-facing text is the most work-intensive part of internationalization. As a developer, you
only need to make sure that strings are marked for translation when appropriate. In Freeciv21, this is done
Expand Down Expand Up @@ -67,7 +69,7 @@ returns the original). This is useful in static contexts.


Not Translated
--------------
==============

While most text should be translated, there are a few cases where this is not wanted:

Expand All @@ -78,7 +80,7 @@ While most text should be translated, there are a few cases where this is not wa


Helper Comments
---------------
===============

When translators work on strings, they are provided with a list taken out of context. They can see the
original text in English and sometimes the source code, but most translators cannot read code. In some
Expand Down Expand Up @@ -112,7 +114,7 @@ In complex cases, adding an example or a short explanation also makes the code e


Character Encodings
-------------------
===================

The way characters are encoded into strings has long been a hot topic of internationalization, and
language-specific character encodings are still around on some systems. Freeciv21 always uses UTF-8 for data
Expand All @@ -128,7 +130,7 @@ be rarely, if ever, needed.


Common Difficulties
-------------------
===================

Every language is different, and there is no reason for the order of words or even sentences to be the same
as in English. When possible, it is thus preferable to provide the translators with full sentences or
Expand Down
2 changes: 2 additions & 0 deletions docs/Coding/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>

.. include:: /global-include.rst

Logging
*******

Expand Down
8 changes: 2 additions & 6 deletions docs/Coding/mapgen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@
.. SPDX-FileCopyrightText: Erik Sigra <sigra@home.se>
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>

.. Custom Interpretive Text Roles for longturn.net/Freeciv21
.. role:: unit
.. role:: improvement
.. role:: wonder
.. role:: advance
.. include:: /global-include.rst

Map Generator
*************
Expand Down Expand Up @@ -509,7 +505,7 @@ Player Placement

.. table:: Mode chosen by the generator to generate start positions
:widths: auto
:align: right
:align: center

============ =======
Generator Default
Expand Down
17 changes: 9 additions & 8 deletions docs/Coding/network-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>

.. include:: /global-include.rst

Network Protocol
****************

Expand Down Expand Up @@ -150,14 +152,13 @@ reply its connection is closed.
Delta
=====

If delta is enabled for this packet, the packet-payload (after the bytes used by the packet-header) is followed
by the ``delta-header``. The ``delta-header`` is a bitvector which represents all non-key fields of the
packet. If
the field has changed the corresponding bit is set and the field value is also included in ``delta-body``. The
values of the unchanged fields will be filled in from an old version at the receiving side. The old version
filled in from is the previous packet of the same kind that has the same value in each key field. If the
packet's kind do not have any key fields the previous packet of the same kind is used. If no old version
exists the unchanged fields will be assumed to be zero.
If delta is enabled for this packet, the packet-payload (after the bytes used by the packet-header) is
followed by the ``delta-header``. The ``delta-header`` is a bitvector which represents all non-key fields of
the packet. If the field has changed the corresponding bit is set and the field value is also included in
``delta-body``. The values of the unchanged fields will be filled in from an old version at the receiving
side. The old version filled in from is the previous packet of the same kind that has the same value in each
key field. If the packet's kind do not have any key fields the previous packet of the same kind is used. If
no old version exists the unchanged fields will be assumed to be zero.

For a ``bool`` field, another optimization called ``bool-header-folding`` is applied. Instead of sending an
indicator in the bitvector if the given ``bool`` value has changed, and so using 1 byte for the real value,
Expand Down
14 changes: 8 additions & 6 deletions docs/Coding/scorelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
.. SPDX-FileCopyrightText: Freeciv21 and Freeciv Contributors
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>

.. include:: /global-include.rst

Format Description of the Scorelog
**********************************

Expand All @@ -11,20 +13,20 @@ are always the last parameter and so extend until the end of line.

The following commands exists:

* :code:`id <game-id>` : :code:`<game-id>` is a string without whitespaces which is used to match a scorelog
* :code:`id <game-id>` --- :code:`<game-id>` is a string without whitespaces which is used to match a scorelog
against a savegame.

* :code:`tag <tag-id> <descr>` : Add a data-type (tag) the :code:`<tag-id>` is used in the 'data' commands
* :code:`tag <tag-id> <descr>` --- Add a data-type (tag) the :code:`<tag-id>` is used in the 'data' commands
:code:`<descr>` is a string without whitespaces which identified this tag.

* :code:`turn <turn> <number> <descr>` : Adds information about the :code:`<turn>` turn :code:`<number>` can
* :code:`turn <turn> <number> <descr>` --- Adds information about the :code:`<turn>` turn :code:`<number>` can
be for example year :code:`<descr>` may contain whitespaces.

* :code:`addplayer <turn> <player-id> <name>` : Adds a player starting at the given turn (inclusive).
* :code:`addplayer <turn> <player-id> <name>` --- Adds a player starting at the given turn (inclusive).
:code:`<player-id>` is a number which can be reused :code:`<name>` may contain whitespaces.

* :code:`delplayer <turn> <player-id>` : Removes a player from the game. The player was active till the given
* :code:`delplayer <turn> <player-id>` --- Removes a player from the game. The player was active till the given
turn (inclusive) :code:`<player-id>` used by the creation.

* :code:`data <turn> <tag-id> <player-id> <value>` : Gives the value of the given tag for the given player for
* :code:`data <turn> <tag-id> <player-id> <value>` --- Gives the value of the given tag for the given player for
the given turn.
2 changes: 2 additions & 0 deletions docs/Contributing/bugs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
.. SPDX-FileCopyrightText: Freeciv21 and Freeciv Contributors
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>

.. include:: /global-include.rst

Filing Bugs and Enhancement Requests
************************************

Expand Down
6 changes: 1 addition & 5 deletions docs/Contributing/capitalized-terms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>

.. Custom Interpretive Text Roles for longturn.net/Freeciv21
.. role:: unit
.. role:: improvement
.. role:: wonder
.. role:: advance
.. include:: /global-include.rst

List of Capitalized Terms
*************************
Expand Down
7 changes: 5 additions & 2 deletions docs/Contributing/dev-env.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. SPDX-License-Identifier: GPL-3.0-or-later
.. SPDX-FileCopyrightText: James Robertson <jwrober@gmail.com>

.. include:: /global-include.rst

Set up a Development Environment
********************************

Expand Down Expand Up @@ -116,8 +118,9 @@ Once installed, you can then import the Freeciv21 project into it. Follow these
#. Find :file:`freeciv21/CMakeLists.txt`
#. :menuselection:`Session --> Rename Current Session` to Freeciv21
#. :menuselection:`Project --> Open Configuration --> Language Support`. Click on the
:guilabel:`Language Support` tab and ensure that the C++ Profile is `c++17`, the C Profile is `c99`, the
OpenCL C Profile is `CL1.1`, the CUDA C Profile is `c++11`, and finall the Compiler for Path is `GCC`.
:guilabel:`Language Support` tab and ensure that the C++ Profile is :guilabel:`c++17`, the C Profile is
:guilabel:`c99`, the OpenCL C Profile is :guilabel:`CL1.1`, the CUDA C Profile is :guilabel:`c++11`, and
finally the Compiler for Path is :guilabel:`GCC`.
#. Allow kdevelop to parse all of the code. This can take a while. Eventually you will see a full tree of
the code in the Projects tab on the left.

Expand Down
2 changes: 2 additions & 0 deletions docs/Contributing/eval-pull-request.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
.. SPDX-FileCopyrightText: Louis Moureaux <m_louis30@yahoo.com>
.. SPDX-FileCopyrightText: Pranav Sampathkumar <pranav.sampathkumar@gmail.com>

.. include:: /global-include.rst

Evaluating a Pull Request
*************************

Expand Down
Loading
Loading