hash stringlengths 32 32 | doc_id stringlengths 5 12 | section stringlengths 5 1.47k | content stringlengths 0 6.67M |
|---|---|---|---|
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 6.2 Packet Switched Handover and Roaming Principles | The introduction of a UMTS core Network as described in section 11.1 illustrates the requirement for inter-connection with the legacy GSM system to allow inter-PLMN roaming and handover.
Even though there is no current GPRS deployment, the operator may decide to deploy a GPRS network prior to the deployment of a UMTS network. Therefore, the introduction of a UMTS Core Network may require to be inter-connected to the legacy packet network.
As in the circuit switched case, roaming and handover to/from UMTS should be performed in the simplest manner that requires as little change as possible to the GPRS network and standards, i.e. inter-GSN handover functionality. In addition, access is provided to the GPRS network using the existing subscriber profiles and current network interfaces.
A similar figure to Figure 17 is illustrated in Figure 19. Notice that it also leaves the current GPRS specifications mainly untouched whereupon the UMTS core network acts towards the GSN like a GSN by providing for example Gn. Further, it should be observed that GPRS subscriptions belong to the HLR whilst UMTS subscriptions exist in the HLR release 99.
Figure 22 Inter-Operability between GSNs and UMTS
Note: No physical implementation should be taken from Figure 19. As a further note, no interworking functions are shown to ease clarity, but however should not be precluded.
From Figure 19 it can be seen that to provide inter-working between legacy packet switched and UMTS packet switched services, the information exchanged over the Iu must provide the necessary parameters to enable the core networks to communicate via for example the Gn interface for handover purposes.
Also note that from the above diagram, the same principles are used as in the circuit switched services to provide seamless roaming. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 6.2.1 Implications | The active PDP context resides in the same GGSN even after a handover between GSM and UMTS (both directions). This corresponds in principle to the anchor concept on the circuit switched side, but note that whereas packet sessions are long lived, the anchor MSC remains only for the duration of a CS call (typically much shorter than a packet session).
Assuming an internal structure in UMTS CN that contains logical GGSN and SGSN nodes, the signalling over the inter-system GGSN-SGSN interface should be a joint evolution of Gn for the GSM system and UMTS. I.e., when Gn evolves in the sequence of GSM releases, Gn should include any new or updated information necessary for interoperation.
The corresponding SGSN-SGSN inter-system interface (also Gn) should also be evolved together. However, in this case the changes relative to the current GPRS release may possibly be more profound. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 6.2.2 Signalling procedures | The signalling procedures shows how handover UMTS <-> GSM GPRS can be done. The parameters carried by each message is not complete and shall be seen as examples of important information carried be the messages.
The signalling sequences shows the case when the UMTS 3G_SGSN and the GPRS 2G_SGSN are located in separate “physical” nodes.
If the 3G_SGSN and 2G_SGSN are located within the same "physical" node, no signalling are needed between 3G_SGSN and 2G_SGSN.
For handover in the UMTS to GSM GPRS direction the intention is to re-use the handover principles of GSM GPRS today in order to limit the changes in GSM GPRS and to take the changes if any on the UMTS side. The below specified messages is standard GSM 2+ messages (when applicable)
Handover from UMTS to GSM GPRS
Figure 23: UMTS to GSM GPRS, Inter SGSN Routing Area Update Procedure
The UE [2] or UTRAN [2] decides to perform handover which leads to that the UE switch to the new cell under the new system.
The UE sends a Routing Area Update Request (old RAI, old P-TMSI) to the new 2G_SGSN. The BSS shall add the Cell Global Identity including the RAC and LAC of the cell where the message was received before passing the message to the 2G_SGSN.
The new 2G_SGSN sends SGSN Context Request (old RAI, old P-TMSI, New SGSN Address) to the old 3G_SGSN to get the MM and PDP contexts for the UE (The old RAI received from the UE is used to derive the old 3G_SGSN address). The old 3G_SGSN responds with SGSN Context Response (MM Context, e.g. IMSI, PDP Contexts, e.g. APN).
Security functions may be executed.
The new 2G_SGSN sends an SGSN Context Acknowledge message to the old 3G_SGSN. This informs the old 3G_SGSN that the new 2G_SGSN is ready to receive data packets belonging to the activated PDP contexts.
The new 2G_SGSN sends Update PDP Context Request (new SGSN Address) to the GGSN concerned. The GGSN update their PDP context fields and return Update PDP Context Response.
The new 2G_SGSN informs the HLR of the change of SGSN by sending Update GPRS Location (SGSN Number, SGSN Address, IMSI) to the HLR.
The HLR sends Cancel Location (IMSI) to the old 3G_SGSN. The old 3G_SGSN removes the MM and PDP contexts.
The old 3G_SGSN acknowledges with Cancel Location Ack (IMSI).
The old 3G_SGSN request the SRNS to release the radio resources by sending Bearer Release. The SRNS responds with Bearer Release Response.
The HLR sends Insert Subscriber Data (IMSI, GPRS subscription data) to the new 2G_SGSN. The 2G_SGSN constructs an MM context for the UE and returns an Insert Subscriber Data Ack (IMSI) message to the HLR.
The HLR acknowledges the Update Location by sending Update GPRS Location Ack (IMSI) to the new 2G_SGSN.
The new 2G_SGSN validates the UE's presence in the new RA. The new 2G_SGSN constructs MM and PDP contexts for the UE. A logical link is established between the new 2G_SGSN and the UE. The new 2G_SGSN responds to the UE with Routeing Area Update Accept (P‑TMSI).
The UE acknowledges the new P‑TMSI with a Routing Area Update Complete (P‑TMSI).
Note 1: The functionality for forward of packets and handling of GTP sequence numbers is a subject fore more investigation, i.e. FFS.
Handover from GSM GPRS to UMTS
Figure 24: GSM GPRS to UMTS, Inter SGSN Routing Area Update Procedure
The UE/network decides to perform handover which leads to that the UE switch to the new cell, details for this is FFS.
The UE sends a x_Routing Area Update Request (old RAI, old P-TMSI) to the new 3G_SGSN. The SRNS shall add an identifier of the area where the message was received before passing the message to the 3G_SGSN.
The new 3G_SGSN sends SGSN Context Request (old RAI, old P-TMSI, New SGSN Address) to the old 2G_SGSN to get the MM and PDP contexts for the UE (The old RAI received from the UE is used to derive the old 2G_SGSN address). The old 2G_SGSN responds with SGSN Context Response (MM Context, e.g. IMSI, PDP Contexts, e.g. APN).
Security functions may be executed.
The new 3G_SGSN request the SRNS to establish of a radio access bearer by sending Bearer Setup to the SRNS. The SRNS responds with Bearer Setup Response.
The new 3G_SGSN sends an SGSN Context Acknowledge message to the old 2G_SGSN. This informs the old 2G_SGSN that the new 3G_SGSN is ready to receive data packets belonging to the activated PDP contexts.
The new 3G_SGSN sends Update PDP Context Request (new SGSN Address) to the GGSN concerned. The GGSN update their PDP context fields and return Update PDP Context Response.
The new 3G_SGSN informs the HLR of the change of SGSN by sending Update GPRS Location (SGSN Number, SGSN Address, IMSI) to the HLR.
The HLR sends Cancel Location (IMSI) to the old 2G_SGSN. The old 2G_SGSN removes the MM and PDP contexts.
The old 2G_SGSN acknowledges with Cancel Location Ack (IMSI).
The HLR sends Insert Subscriber Data (IMSI, GPRS subscription data) to the new 3G_SGSN. The 3G_SGSN constructs an MM context for the UE and returns an Insert Subscriber Data Ack (IMSI) message to the HLR.
The HLR acknowledges the Update GPRS Location by sending Update Location Ack (IMSI) to the new 3G_SGSN.
The new 3G_SGSN validates the UE's presence in the new RA. The new 3G_SGSN constructs MM and PDP contexts for the UE. A logical link is established between the new SGSN and the UE. The new 3G_SGSN responds to the UE with x_Routing Area Update Accept (P‑TMSI).
The UE acknowledges the new P‑TMSI with a x_Routing Area Update Complete (P‑TMSI).
Note 1: The functionality for forward of packets and handling of GTP sequence numbers (within the box) is a subject fore more investigation, i.e. FFS. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 7 Network Migration And Evolution | The installed base of GSM networks will be very comprehensive at the time of the UMTS roll out. These GSM networks will co-operate very closely with and in many cases be partly integrated into the overall UMTS network. Thus network migration and evolution is a very fundamental aspect to consider when standardising UMTS. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 7.1 Network Migration Scenarios | A number of principally different network migration scenarios can be envisioned, e.g.:
• GSM to GSM release 99 (GSM operator with no UMTS licence and no UMTS roaming/handover agreements).
• GSM to GSM release 99 with support for dual mode ‘UMTS visitors’ (GSM operator with no UMTS licence but with UMTS roaming/handover agreements).
• GSM to GSM/UMTS (GSM operator with a UMTS licence).
• UMTS only PLMN (new UMTS operator with GSM roaming/handover agreements). This scenario is more a matter of network ‘compatibility’ rather than network migration.
A basic assumption is that the provision of UMTS services in most cases will start, from a radio coverage point of view, within ‘islands in a sea of GSM BSS’.
7.2 network migration and evolution requirements
1) The UMTS standard shall consider all aspects of network migration and shall describe the migration process from GSM release 98 to UMTS/GSM release 99, including the aspect of partly updated networks and its consequences on end-user services etc.
2) While fulfilling the SMG1 requirements the UMTS standard shall aim at minimising the impact on the existing GSM networks delivering only GSM. It is recognised that GSM/GPRS standards will need developments for UMTS however these should not adversely impact the networks that offer GSM only.
3) It shall be possible to perform the network migration process of a PLMN independently of co-operating PLMNs.
4) It shall be possible to gradually migrate a PLMN, i.e. the UMTS standard shall allow network elements compliant with different GSM releases to co-exist within a PLMN.
5) The impact on end-user service level for partly updated PLMN(s) is FFS.
6) Internetworking within a PLMN as well as between different PLMNs shall allow operators to utilise current backbone networks (dedicated for GSM traffic only or carrying non-mobile traffic as well according to non-PLMN specific standards).
7) A GSM/UMTS mobile terminal shall be reachable from an external network (PSTN/ISDN, IP, X.25) regardless of the mobile terminal being served by BSS or UTRAN.
8) A terminal in an external network, as well as the external networks themselves, shall not need to know if the GSM/UMTS mobile terminal is served by BSS or UTRAN.
9) The user equipment shall not need to change the E.164 or IP address at handover between UTRAN and BSS. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8 Protocol Architecture | |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8.1 IU Signalling Bearer Requirements for IP Domain | |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8.1.1 Connectionless and Connection Oriented Services | Connection-oriented and connection-less IU Signalling Bearers are required. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8.1.2 Dynamic Bandwidth Allocation | The IU Signalling Bearer shall support rapid and flexible allocation and de-allocation of IU transport resources. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8.1.3 Reliable Transfer | The IU Signalling Bearer shall provide reliable delivery of signalling data. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8.1.4 Flow Control | The IU Signalling Bearer shall provide throttling mechanisms to adapt to intermittent congestion in the UTRAN or Core Network. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8.1.5 Redundancy and Load Sharing | To handle detected failures and signalling data congestion, the IU Signalling Bearer shall be capable of dynamically routing over alternate routes that minimise delay. If the delay metrics over alternative routes are identical, the IU Signalling Bearer shall be capable of spreading traffic over the identical paths, thus performing load sharing. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8.1.6 Large Pdu Size | To support large transactions, it is important for the IU Signalling Bearer to provide a Signalling Data Unit size, large enough to allow for all signalling messages to be transferred without fragmentation. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8.1.7 Signalling Bearer Management | To support supervision of IU Signalling Bearers, mechanisms for managing IU Signalling Bearers shall be used to provide status information to the RANAP for individual UE(s). The signalling bearer shall also maintain a consistent UE Activation State in the access and the core network. |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 8.1.8 Transport Media Independence | The IU Signalling Bearer shall be independent of the underlying transport media (e.g. ATM). |
6e5fdf15efa25f132d2e779f583f3558 | 23.920 | 9 History | Document history
V1.0.0
June 1999
Creation of document from 23.20, all sections except 7
V2.0.0
June 1999
Some editorial changes in order to prepare the document for the approval by the TSG SA, June 1999 meeting
V3.0.0
July 1999
Template changed, clauses and sub-clauses numbering corrected, administrative clauses added.
v.3.1.0
October 1999
Incorporation of all the Change Requests approved at TSG SA#5 |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 1 Scope | The present document identifies the parameters of the access stratum part of the UE radio access capabilities. Furthermore, some reference configurations of these values are defined. The intention is that these configurations will be used for test specifications. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 2 References | [1] 3GPP TS 25.323: "Packet Data Convergence Protocol (PDCP) protocol". |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 3 Abbreviations | For the purposes of the present document, the following abbreviations apply:
UE User Equipment
UMTS Universal Mobile Telecommunication System
UTRAN UMTS Terrestrial Radio Access Network |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4 UE radio access capability parameters | In the following the UE radio capability parameters are defined. In addition the relevant RRC configuration parameters are shown when applicable. When using the RRC configuration parameters, UTRAN needs to respect the UE capabilities. Only parameters for which there is a need to set different values for different UEs are considered as UE capability parameters. Therefore, the capabilities that are the same for all UEs, including baseline capabilities, are not listed here.
UTRAN is responsible for the respect of the UE capabilities when configuring the RBs. Actions in the UE when capabilities are in conflict with a UTRAN request are specified in RRC. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.1 PDCP parameters | Header compression algorithm supported
Defines whether header compression algorithms will be supported by the UE. If it will be supported it will be the RFC 2507 as specified in 3GPP TS 25.323. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.2 BMC parameters | No UE radio access capability parameters identified. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.3 RLC parameters | NOTE: It is FFS whether some of the RLC functions should be considered as UE capabilities.
Total RLC AM buffer size
The total buffer size across all RLC AM entities puts requirements on memory.
UTRAN controls that the UE capability can be fulfilled through the following parameters:
1. The number of RLC AM entities configured (no explicit RRC parameter);
2. UL PU size;
3. Transmission window size (#PUs);
4. Receiving window size (FFS whether this is configurable).
The following criterion must be fulfilled in the configuration:
where i is the RLC "entity number"
Maximum number of AM entities
The number of AM entities affect the main part of the total processing and memory capacity to be shared between different RLC machines. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.4 MAC parameters | No capability parameters identified. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.5 PHY parameters | |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.5.1 Transport channel parameters in downlink | Maximum sum of number of bits of all transport blocks being received at an arbitrary time instant
NOTE: "Being received" refers to all bits in the active TFC within the TFCS over all simultaneous transport channels received by the UE. "Arbitrary time instant" means that the time instant corresponding to the highest sum of number of bits is relevant. This note also applies to similar parameter definitions below
This parameter is defined as:
i(Ni)
where Ni is defined as the number of bits in transport block #i, and the sum is over all transport blocks being received at an arbitrary time instant. All transport blocks that are to be simultaneously received by the UE on DCH, FACH, PCH and DSCH transport channels are included in the parameter.
A UE does not need to support a TFC within the TFCS for which the sum of Number of Transport Blocks * Transport Block size over all simultaneous transport channels is larger than what the UE capability indicates.
Maximum sum of number of bits of all convolutionally coded transport blocks being received at an arbitrary time instant.
This parameter is defined similar to the parameter above, but the sum includes only convolutionally coded transport blocks.
Maximum sum of number of bits of all turbo coded transport blocks being received at an arbitrary time instant.
This parameter is defined similar to the parameter above, but the sum includes only turbo coded transport blocks.
Maximum number of simultaneous transport channels
This is defined as the maximum number of Transport Channels that should be possible to process simultaneously, not taking into account the rate of each Transport Channel.
The number of simultaneous transport channels affects how the total memory space and processing capacity can be shared among the transport channels.
A UE does not need to support more simultaneous transport channels than the UE capability allows for.
Maximum number of simultaneous CCTrCH
CCTrCH should be interpreted as CCTrCH of any type, i.e. consisting of DCH, FACH or DSCH.
Maximum total number of transport blocks received within TTIs that end within the same 10 ms interval
All transport blocks that are to be simultaneously received by the UE on DCH, FACH, PCH and DSCH transport channels are included in the parameter.
Relates to processing requirements for CRC in downlink.
A UE does not need to support a TFC within the TFCS for which the sum of Number of Transport Blocks is larger than what the UE capability indicates.
Maximum number of TFC in the TFCS
The maximum number of TFC in a TFCS sets the size of the TFCI to TFCS mapping table to be handled by the UE.
Maximum number of TF
The maximum total number of downlink transport formats the UE can store.
Support for turbo decoding
Defines whether turbo decoding is supported or not.
The UTRAN configuration parameter is Type of channel coding which is part of the Transport format set (TFS) of each transport channel. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.5.2 Transport channel parameters in uplink | Maximum sum of number of bits of all transport blocks being transmitted at an arbitrary time instant
NOTE: "Being transmitted" refers to all bits in the active TFC within the TFCS over all simultaneous transport channels transmitted by the UE. "Arbitrary time instant" means that the time instant corresponding to the highest sum of number of bits is relevant. This note also applies to similar parameter definitions below.
This parameter is defined as:
i(Ni)
where Ni is defined as the number of bits in transport block #i, and the sum is over all transport blocks being transmitted at an arbitrary time instant.
This parameter is related to memory requirements for uplink data received from MAC before it can be transmitted over the radio interface. As shown in Figure 4.1 the worst case occurs for the maximum TTI.
A UE does not need to support a TFC within the TFCS for which the sum of Number of Transport Blocks * Transport Block size over all simultaneous transport channels is larger than what the UE capability indicates.
Maximum sum of number of bits of all convolutionally coded transport blocks being transmitted at an arbitrary time instantThis parameter is defined similar to the parameter above, but the sum includes only convolutionally coded transport blocks.
Maximum sum of number of bits of all turbo coded transport blocks being transmitted at an arbitrary time instant
This parameter is defined similar to the parameter above, but the sum includes only turbo coded transport blocks.
Maximum number of simultaneous transport channels
The number of simultaneous transport channels affects how the total memory space and processing capacity can be shared among the transport channels.
UTRAN shall not set up more simultaneous transport channels than the UE capability allows for.
Maximum number of simultaneous CCTrCH
TDD only. For FDD there is always only one CCTrCH at a time.
Maximum total number of transport blocks transmitted within TTIs that start at the same time
Relates to processing requirements for CRC in uplink.
A UE does not need to support the TFC within the TFCS for which the sum of Number of Transport Blocks is larger than what the UE capability allows for.
Maximum number of TFC in the TFCS
The maximum number of TFC in a TFCS sets the size of the TFCI to TFCS mapping table to be handled by the UE.
Maximum number of TF
The maximum total number of uplink transport formats the UE can store.
Support for turbo encoding
Defines whether turbo encoding is supported or not.
The UTRAN configuration parameter is Type of channel coding which is part of the Transport format set (TFS) of each transport channel.
Figure 4.1: UE transport channel processing limitations in uplink
NOTE: When CPCH is supported, then simultaneous DPCCH & SCCPCH reception is needed. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.5.3 FDD Physical channel parameters in downlink | Maximum number of DPCH/PDSCH codes to be simultaneously received
Defines the number of codes the UE is capable of receiving in parallel. For DPCH in soft/softer handover, each DPCH is only calculated once in this capability. The capability does not include codes used for S-CCPCH.
Maximum number of physical channel bits received in any 10 ms interval (DPCH, PDSCH, S-CCPCH)
Defines the number of physical channel bits the UE is capable of receiving. For DPCH in soft/softer handover, each DPCH is only calculated once in this capability.
The number of DPCH channel bits indicates the capability for normal, un-compressed mode.
The parameter also indicates the capability of the UE to support compressed mode by spreading factor reduction. For parameter values up to and including 9600 bits, the UE shall also be able to support compressed mode by SF reduction when operating in normal mode, at any value up to the reported capability. For parameter values greater than 9600 bits, the UE shall be able to support compressed mode by spreading factor reduction when operating, in normal mode, at any value up to half the reported capability or 9600bits, whichever is greater.
Support for SF 512
Spreading factor 512 should not be mandatory for all UEs.
The corresponding configuration parameter is Spreading factor which is part of Downlink DPCH info.
Support of PDSCH
Support of PDSCH is only required for some RAB realizations, and is therefore a UE capability.
The corresponding configuration parameter is Downlink transport channel type, which is part of RB mapping info.
Simultaneous reception of SCCPCH and DPCH
Simultaneous reception of SCCPCH and DPCH, i.e. simultaneous reception of FACH and DCH is required for e.g. DRAC procedure, but it should not be mandatory for all UEs (e.g. speech only UEs).
There is no specific configuration parameter.
Simultaneous reception of SCCPCH, DPCH and PDSCH
Simultaneous reception of SCCPCH, DPCH and PDSCH, i.e. simultaneous reception of FACH, DCH and DSCH is required for e.g. simultaneous use of DSCH and the DRAC procedure, but it should not be mandatory for all UEs (e.g. speech only UEs). The PDSCH part of this capability is only relevant if the UE supports PDSCH, as covered by the capability "Support of PDSCH".
There is no specific configuration parameter.
Maximum number of simultaneous S-CCPCH radio links
Defines the maximum number of radio links on which the UE is capable of receiving S-CCPCH simultaneously. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.5.4 FDD physical channel parameters in uplink | Maximum number of DPDCH bits per 10 ms
This capability combines the 'Max number of DPDCH' and 'Minimum SF' capabilities into one capability. Note that no flexibility is lost due to this, as multiple DPDCH is only used for SF=4, i.e. when the number of DPDCH bits exceed a certain value.
The number of DPDCH channel bits indicates the capability for normal, un-compressed mode. The UE shall also be able to support compressed mode by SF reduction when operating at this value.
Support of PCPCH
Support of PCPCH is only required for some RAB realizations, and is therefore a UE capability.
There is no specific configuration parameter. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.5.5 TDD physical channel parameters in downlink | Maximum number of timeslots per frame
Defines the maximum number of timeslots per frame that the UE can receive.
Maximum number of physical channels per frame
This parameter defines how many physical channels can be received during one frame. The distribution of the received physical channels on the received timeslots can be arbitrary.
Minimum SF
Defines the minimum SF supported by the UE.
Support of PDSCH
Defines whether PDSCH is supported or not.
Maximum number of physical channels per timeslot
This parameter defines how many physical channels can be received within one timeslot. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.5.6 TDD physical channel parameters in uplink | Maximum Number of timeslots per frame
Defines the maximum number of timeslots per frame that the UE can transmit.
Maximum number of physical channels per timeslot
Defines the maximum number physical channels transmitted in parallel during one timeslot.
Minimum SF
Defines the minimum SF supported by the UE.
Support of PUSCH
Defines whether PUSCH is supported or not. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.5.7 RF parameters | UE power class
The value is fixed per UE and is not related to any configuration parameter.
Radio frequency bands
Defines the uplink and downlink frequency bands supported by the UE.
Configuration parameters are UTRA RF Channel numbers for uplink and downlink, which are part of Frequency info.
Tx/Rx frequency separation
Defines the uplink/downlink frequency separations supported by the UE.
Configuration parameters are UTRA RF Channel numbers for uplink and downlink, which are part of Frequency info.
Chip rate capability
Chip rates supported by the UE.
Corresponding configuration parameter is chip rate, which is part of Frequency info. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.6 Multi-mode related parameters | Support of UTRA FDD/TDD
Defines whether UTRA FDD and/or TDD are supported.
There is no explicit configuration parameter. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.7 Multi-RAT related parameters | Support of GSM
Defines whether GSM is supported or not.
There is no explicit configuration parameter.
Support of multi-carrier
Defines whether multi-carrier is supported or not.
There is no explicit configuration parameter. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.8 LCS related parameters | Standalone location method(s) supported
Defines if a UE can measure its location by some means unrelated to UTRAN (e.g. if the UE has access to a standalone GPS receiver).
OTDOA UE based method supported
Defines if a UE supports the OTDOA UE based schemes.
Network Assisted GPS support
Defines if a UE supports either of the two types of assisted GPS schemes, namely "Network based", "UE based", "Both", or "none".
GPS reference time capable
Defines if a UE has the capability to measure GPS reference time as defined in 25.215.
Support for IPDL
Defines if a UE has the capability to use IPDL to enhance its "SFN-SFN observed time difference –type 2" measurement. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 4.9 Measurement related capabilities | Need for downlink compressed mode
Defines whether the UE needs compressed mode in the downlink in order to perform inter-frequency or inter-RAT measurements. There are separate parameters for measurements on each UTRA mode, on each RAT, and in each frequency band.
Need for uplink compressed mode
Defines whether the UE needs compressed mode in the uplink in order to perform inter-frequency or inter-RAT measurements. There are separate parameters for measurements on each UTRA mode, on each RAT, and in each frequency band. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 5 Possible UE radio access capability parameter settings | |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 5.1 Value ranges | Table 5.1: UE radio access capability parameter value ranges
UE radio access capability parameter
Value range
PDCP parameters
Header compression algorithm supported
Yes/No
RLC parameters
Total RLC AM buffer size
2,10,50,100,150,500,1000 kBytes
Maximum number of AM entities
3,4,5,6,8,16,32
PHY parameters
Transport channel parameters in downlink
Maximum sum of number of bits of all transport blocks being received at an arbitrary time instant
640, 1280, 2560, 3840, 5120, 6400, 7680, 8960, 10240, 20480, 40960, 81920, 163840
Maximum sum of number of bits of all convolutionally coded transport blocks being received at an arbitrary time instant
640, 1280, 2560, 3840, 5120, 6400, 7680, 8960, 10240, 20480, 40960, 81920, 163840
Maximum sum of number of bits of all turbo coded transport blocks being received at an arbitrary time instant
640, 1280, 2560, 3840, 5120, 6400, 7680, 8960, 10240, 20480, 40960, 81920, 163840
Maximum number of simultaneous transport channels
4, 8, 16, 32
Maximum number of simultaneous CCTrCH
1, 2, 3, 4, 5, 6, 7, 8
Maximum total number of transport blocks received within TTIs that end within the same 10 ms interval
4, 8, 16, 32, 48, 64, 96, 128, 256, 512
Maximum number of TFC in the TFCS
16, 32, 48, 64, 96, 128, 256, 512, 1024
Maximum number of TF
32, 64, 128, 256, 512, 1024
Support for turbo decoding
Yes/No
Transport channel parameters in uplink
Maximum sum of number of bits of all transport blocks being transmitted at an arbitrary time instant
640, 1280, 2560, 3840, 5120, 6400, 7680, 8960, 10240, 20480, 40960, 81920, 163840
Maximum sum of number of bits of all convolutionally coded transport blocks being transmitted at an arbitrary time instant
640, 1280, 2560, 3840, 5120, 6400, 7680, 8960, 10240, 20480, 40960, 81920, 163840
Maximum sum of number of bits of all turbo coded transport blocks being transmitted at an arbitrary time instant
640, 1280, 2560, 3840, 5120, 6400, 7680, 8960, 10240, 20480, 40960, 81920, 163840
Maximum number of simultaneous transport channels
2, 4, 8, 16, 32
Maximum number of simultaneous CCTrCH of DCH type (TDD only)
1, 2, 3, 4, 5, 6, 7, 8
Maximum total number of transport blocks transmitted within TTIs that start at the same time
2, 4, 8, 16, 32, 48, 64, 96, 128, 256, 512
Maximum number of TFC in the TFCS
4, 8, 16, 32, 48, 64, 96, 128, 256, 512, 1024
Maximum number of TF
32, 64, 128, 256, 512, 1024
Support for turbo encoding
Yes/No
FDD Physical channel parameters in downlink
Maximum number of DPCH/PDSCH codes to be simultaneously received
1, 2, 3, 4, 5, 6, 7, 8
Maximum number of physical channel bits received in any 10 ms interval (DPCH, PDSCH, S-CCPCH)
600, 1200, 2400, 3600, 4800, 7200, 9600, 14400, 19200, 28800, 38400, 48000, 57600, 67200, 76800
Support for SF 512
Yes/No
Support of PDSCH
Yes/No
Simultaneous reception of SCCPCH and DPCH
Yes/No
Simultaneous reception of SCCPCH, DPCH and PDSCH
Yes/No
Maximum number of simultaneous S-CCPCH radio links
1
NOTE: Only the value 1 is part of R99
FDD Physical channel parameters in uplink
Maximum number of DPDCH bits transmitted per 10 ms
600, 1200, 2400, 4800, 960, 19200, 28800, 38400, 48000, 57600
Support of PCPCH
Yes/No
TDD physical channel parameters in downlink
Maximum number of timeslots per frame
1..14
Maximum number of physical channels per frame
1,2,3..,224
Minimum SF
16, 1
Support of PDSCH
Yes/No
Maximum number of physical channels per timeslot
1..16
TDD physical channel parameters in uplink
Maximum Number of timeslots per frame
1..14
Maximum number of physical channels per timeslot
1, 2
Minimum SF
16,8,4,2,1
Support of PUSCH
Yes/No
RF parameters
FDD RF parameters
UE power class
(25.101 subclause 6.2.1)
3, 4
NOTE: Only power classes 3 and 4 are part of R99
Tx/Rx frequency separation
(25.101 subclause 5.3) .
NOTE: Not applicable if UE is not operating in frequency band a
190 MHz
174.8-205.2 MHz
134.8-245.2 MHz
RF parameters
TDD RF parameters
UE power class
(25.102)
2,3
NOTE: Only power classes 2 and 3 are part of R99
Radio frequency bands
(25.102)
a), b), c), a+b), a+c), a+b+c)
Chip rate capability
(25.102)
3.84,1.28
Multi-mode related parameters
Support of UTRA FDD/TDD
FDD, TDD, FDD+TDD
Multi-RAT related parameters
Support of GSM
Yes/No
Support of multi-carrier
Yes/No
LCS related parameters
Standalone location method(s) supported
Yes/No
Network assisted GPS support
Network based / UE based / Both/ None
GPS reference time capable
Yes/No
Support for IPDL
Yes/No
Support for OTDOA UE based method
Yes/No
Measurement related capabilities
Need for downlink compressed mode
Yes/No (per frequency band, UTRA mode and RAT)
Need for uplink compressed mode
Yes/No (per frequency band, UTRA mode and RAT) |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 5.2 Reference UE radio access capability combinations | Based on required UE radio access capabilities to support reference RABs as defined in clause 6, this clause lists reference UE Radio Access capability combinations. Subclause 5.2.1 defines reference combinations of UE radio access capability parameters common for UL and DL. Subclause 5.2.2 and 5.2.3 define reference combinations of UE radio access capability parameters that are separate for DL and UL respectively. A reference combination for common UL and DL parameters, one combination for UL parameters and one combination for DL parameters together relate to a UE with a certain implementation complexity, that allows support for one or several combined reference RABs. Combinations for UL and DL can be chosen independently. The bit rate supported by the selected combination of common UL and DL parameters needs to be at least as high as the maximum out of the supported bit rates of the selected combination of DL parameters and the selected combination of UL parameters. Different combinations have different levels of implementation complexity.
For defined reference RABs, it is possible to require a UE to meet a certain reference UE radio access capability combination. Each UE needs to have capabilities complying with a given reference radio access capability combination. Each individual radio access capability parameter as defined in Subclause 5.1 shall be signalled.
The reference combination numbers shall not be used in the signalling of UE radio access capabilities between the UE and UTRAN. Reference UE radio access capability combinations provide default configurations that should be used as a basis for conformance testing against reference RABs.
Allowed values of UE capability parameters are limited by the defined range and granularity of values in Subclause 5.1. Values might change depending on further definition of reference RABs for testing.
5.2.1 Combinations of common UE Radio Access Parameters
for UL and DL
NOTE: It is FFS whether measurement-related capabilities need to be included in the combinations. These capabilities are independent from the supported RABs.
Table 5.2.1.1: UE radio access capability parameter combinations, parameters common for UL and DL
Reference combination of UE Radio Access capability parameters common for UL and DL
32kbps class
64kbps class
128kbps class
384kbps class
768kbps class
2048kbps class
PDCP parameters
Header compression algorithm supported
No
No/Yes NOTE 1
No/Yes
NOTE 1
No/Yes
NOTE 1
No/Yes
NOTE 1
No/Yes
NOTE 1
RLC parameters
Total RLC AM buffer size (kbytes)
10
10
50
50
100
500
Maximum number of AM entities
4
4
5
6
8
8
Multi-mode related parameters
Support of UTRA FDD/TDD
FDD / FDD+TDD / TDD
NOTE 1
Multi-RAT related parameters
Support of GSM
Yes/No
NOTE 1
Support of multi-carrier
Yes/No
NOTE 1
LCS related parameters
Standalone location method(s) supported
Yes/No
NOTE 1
Network assisted GPS support
Network based / UE based / Both/ None
NOTE 1
GPS reference time capable
Yes/No
NOTE 1
Support for IPDL
Yes/No
NOTE 1
Support for OTDOA UE based method
Yes/No
NOTE 1
RF parameters for FDD
UE power class
3 / 4
NOTE 1
Tx/Rx frequency separation
190 MHz
RF parameters for TDD
Radio frequency bands
A / b / c / a+b / a+c / b+c / a+b+c
NOTE 1
Chip rate capability
1.28 / 3.84 Mchip/sec
NOTE 1
UE power class
2 / 3
NOTE 1
NOTE 1: Options represent different combinations that should be supported with Conformance Tests. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 5.2.2 Combinations of UE Radio Access Parameters for DL | Table 5.2.2.1: UE radio access capability parameter combinations, DL parameters
Reference combination of UE Radio Access capability parameters in DL
32kbps class
64kbps class
128kbps class
384kbps class
768kbps class
2048kbps class
Transport channel parameters
Maximum sum of number of bits of all transport blocks being received at an arbitrary time instant
640
3840
3840
6400
10240
20480
Maximum sum of number of bits of all convolutionally coded transport blocks being received at an arbitrary time instant
640
640
640
640
640
640
Maximum sum of number of bits of all turbo coded transport blocks being received at an arbitrary time instant
NA
3840
3840
6400
10240
20480
Maximum number of simultaneous transport channels
8
8
8
8
8
16
Maximum number of simultaneous CCTrCH (FDD)
1
2/1
NOTE 2
2/1
NOTE 2
2/1
NOTE 2
2
2
Maximum number of simultaneous CCTrCH (TDD)
2
3
3
3
4
4
Maximum total number of transport blocks received within TTIs that end at the same time
8
8
16
32
64
96
Maximum number of TFC in the TFCS
32
48
96
128
256
1024
Maximum number of TF
32
64
64
64
128
256
Support for turbo decoding
No
Yes
Yes
Yes
Yes
Yes
Physical channel parameters (FDD)
Maximum number of DPCH/PDSCH codes to be simultaneously received
1
2/1
NOTE 2
2/1
NOTE 2
3
3
3
Maximum number of physical channel bits received in any 10 ms interval (DPCH, PDSCH, S-CCPCH).
1200
3600/2400
NOTE2
7200/4800
NOTE2
19200
28800
57600
Support for SF 512
No
No
No
No
No
No
Support of PDSCH
No
Yes/No
NOTE 1
Yes/No
NOTE 1
No/Yes
NOTE 1
Yes
Yes
Maximum number of simultaneous S-CCPCH radio links
1
1
1
1
1
1
Physical channel parameters (TDD)
Maximum number of timeslots per frame
1
2
4
5
10
12
Maximum number of physical channels per frame
8
9
14
28
64
136
Minimum SF
16
16
16
1/16
NOTE 1
1/16
NOTE 1
1/16
NOTE 1
Support of PDSCH
Yes/No
NOTE 1
Yes
Yes
Yes
Yes
Yes
Maximum number of physical channels per timeslot
8
9
9
9
9
13
NOTE 1: Options represent different combinations that should be supported with conformance tests.
NOTE 2: Options depend on the support of PDSCH. The highest value is required if PDSCH is supported. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 5.2.3 Combinations of UE Radio Access Parameters for UL | Table 5.2.3.1: UE radio access capability parameter combinations, UL parameters
Reference combination of UE Radio Access capability parameters in UL
32kbps class
64kbps class
128kbps class
384kbps class
768kbps class
Transport channel parameters
Maximum sum of number of bits of all transport blocks being transmitted at an arbitrary time instant
640
3840
3840
6400
10240
Maximum sum of number of bits of all convolutionally coded transport blocks being transmitted at an arbitrary time instant
640
640
640
640
640
Maximum sum of number of bits of all turbo coded transport blocks being transmitted at an arbitrary time instant
NA
3840
3840
6400
10240
Maximum number of simultaneous transport channels
4
8
8
8
8
Maximum number of simultaneous CCTrCH(TDD only)
1
2
2
2
2
Maximum total number of transport blocks transmitted within TTIs that start at the same time
4
8
8
16
32
Maximum number of TFC in the TFCS
16
32
48
64
128
Maximum number of TF
32
32
32
32
64
Support for turbo encoding
No
Yes
Yes
Yes
Yes
Physical channel parameters (FDD)
Maximum number of DPDCH bits transmitted per 10 ms
1200
2400
4800
9600
19200
Simultaneous reception of SCCPCH and DPCH
NOTE 2
No
No
Yes/No
NOTE 1
Yes/No
NOTE 1
Yes/No
NOTE 1
Simultaneous reception of SCCPCH, DPCH and PDSCH
NOTE 2
No
No
No
No
No
Support of PCPCH
No
No
No
No
No
Physical channel parameters (TDD)
Maximum Number of timeslots per frame
1
2
3
7
9
Maximum number of physical channels per timeslot
1
1
1
1
2
Minimum SF
8
2
2
2
2
Support of PUSCH
Yes/No
NOTE 1
Yes
Yes
Yes
Yes
NOTE 1: Options represent different combinations that should be supported with conformance tests.
NOTE 2: The downlink parameters 'Simultaneous reception of SCCPCH and DPCH' and 'Simultaneous reception of SCCPCH, DPCH and PDSCH' are included in the combinations for uplink as their requirements relate to the uplink data rate. Simultaneous reception of SCCPCH and DPCH is required for the DRAC procedure that is intended for controlling uplink transmissions. In release 99, this is limited to 1 SCCPCH. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 6 Usage of UE radio access capabilities | NOTE: The rationale for the parameter combination settings will be explained here. |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 6.1 Examples of reference radio access bearers | In Table 6.1 reference RAB A-G are defined with some characteristics that impact the required UE Radio Access capabilities. These reference RABs shall be seen as example RABs covered by the reference UE radio access capability combinations defined in Subclause 5.2. Reference RABs for conformance testing are specified in TS 34.108.
Table 6.1: Reference RABs
Reference RAB
A
B
C
D
E
F
G
RAB characteristics and mapping to DCH
Coding (CC/TC)
Conversational speech 4.75-12.2 kbps (20 ms TTI)
CC, Only one rate per RAB
Conversational 64 kbps
(40 ms TTI)
TC
Streaming
max. 57.6 kbps
(40 ms TTI)
TC
Interactive/
Background max. 32 kbps
(10 ms TTI)
CC
Interactive/
Background max. 64 kbps
(20 ms TTI)
TC
Interactive/
Background max. 384 kbps
(10/20 ms TTI)
TC
Interactive/
Background max. 2048 kbps
(10 ms TTI)
TC
DCH carrying DCCH
(rate, TTI)
3.4kpbs, 40ms
3.4kbps, 40ms/
6.4kbps, 20ms
3.4kbps, 40ms/
6.4kbps, 20ms
3.4kbps, 40ms/
12.8kbps, 10ms
3.4kbps, 40ms/
12.8kbps, 10ms
3.4kbps, 40ms/
12.8kpbs, 10ms
3.4kbps, 40ms/
12.8kpbs, 10ms |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 6.2 Example mappings between reference RABs and capability combinations | The following examples show how the reference RABs of Table 6.1 can be mapped to the reference UE radio access capability combinations that are listed in Clause 5.
Table 6.2: Example mappings between capability combinations and RAB combinations
Reference UE radio access capability combinations
Examples of supported reference RAB combination
32kbps class
One at the time of the following:
- A
- D
64kbps class
One at the time of the following:
- B
- C
- E
- A and D simultaneously
- A and E simultaneously
- A and B simultaneously
- A and C simultaneously
- The RAB combination supported by 32kbps class
128kbps class
One at the time of the following:
- 2 times E
- The RAB combination supported by 64kbps class
384kbps class
One at the time of the following:
- E + B
- 2 times B
- F (TTI 10 ms)
- A and F (TTI 10 ms) simultaneously
- The RAB combination supported by 128kbps class
768kbps class
One at the time of the following:
- F (TTI 20 ms)
- A and F (TTI 20 ms) simultaneously
- 2 times F (TTI 10 ms) in DL.
- The RAB combination supported by 384kbps class
2048kbps class
One at the time of the following:
- G in DL only
- A and G simultaneously
- The RAB combination supported by 768kbps class |
a81d9bd99016b59710681951aa0bdd87 | 25.926 | 7 Mandatory UE radio access capabilities | NOTE: In this section features and requirements that are mandatory for UEs (capabilities that do not need to be signalled) will be listed for information. The normative descriptions are part of the respective specifications.
Annex A (informative):
Change history
Change history
TSG-RAN#
Version
CR
Tdoc RAN
New Version
Subject/Comment
RAN_07
-
-
RP-000052
3.0.0
(03/00)
Approved at TSG-RAN #7 and placed under Change Control
RAN_08
3.0.0
003
RP-000229
3.1.0
(06/00)
Updated Ad Hoc changes
RAN_08
3.0.0
008
RP-000229
3.1.0
CPCH note to the the parameter definitions
RAN_09
3.1.0
010
RP-000368
3.2.0
(09/00)
TDD DL Physical Channel Capability per Timeslot
RAN_09
3.1.0
012
RP-000368
3.2.0
Change to UE Capability definition
RAN_09
3.1.0
013
RP-000368
3.2.0
Physical parameter changes |
5c416a273356c09854424ee0fcfb397b | 21.802 | 1 Scope
| The present document investigates the current specification formats and working methods of 3GPP, and other alternative ways that are available for 3GPP to consider. It provides the following necessary considerations:
- Identification of:
- benefits of the existing ways;
- shortcomings and pain-points of the existing ways; and
- requirements that improvements to the existing ways or the alternative ways should address.
- Study and feasibility analysis of potential new specification formats for 3GPP and corresponding changes to the working methods.
Editor's note: This clause will be cleaned up and finalised once the specification is stable enough to be presented to TSG SA for approval.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 2 References
| The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
- References are either specific (identified by date of publication, edition number, version number, etc.) or non‑specific.
- For a specific reference, subsequent revisions do not apply.
- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document.
[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
[2] 3GPP TR 21.801: "Specification Drafting rules".
[3] Report on User Requirements for a Next Generation Specification Development Tool, NWM Project Oversight Committee, 08.12.22. https://www.3gpp.org/ftp/Email_Discussions/3GPP/221208-Report-Requirements-for-NG-Spec-Tool.zip (accessed 07.07.2025)
[4] LaTeX project. https://www.latex-project.org/
[5] Gitflow Workflow | Atlassian Git Tutorial. https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 3 Definitions of terms, symbols and abbreviations
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 3.1 Terms
| For the purposes of the present document, the terms given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1].
Consumer: A person who reads the specification such as an Original Equipment Manufacturer (OEM), a mobile network operator (MNO), an implementor, government regulatory body, researcher, automated text processing tool, or the general public.
Contributor: A person who contributes to the specification, e.g., a delegate, by submitting change requests (CRs) or TDocs.
Editor: A person who merges changes into the specification, e.g., a rapporteur or MCC.
source specification: A version of a 3GPP TR or TS used as the basis for revision, to produce a new version.
target specification: A 3GPP TR or TS resulting from a source specification and a set of approved changes.
NOTE: The above definitions for source specification and target specification apply both to specifications under change control and those not yet under change control.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 3.2 Symbols
| For the purposes of the present document, the following symbols apply:
µ Average
σ Standard Deviation
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 3.3 Abbreviations
| For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1].
WYSIWYG What You See Is What You Get
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 4 Assessment of existing specification formats and working methods, and requirements for any improvements
| Editor's note: corresponds to objective 1.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 4.1 Benefits of current tools
| These benefits may in future be achieved by other means than the current tools and file formats used.
1. Familiarity
The current set of tools are well known to delegates. 3GPP TR 21.801 [2] captures all requirements and recommendations, accumulated since 1999. Further, there is institutional expertise in checking that this is done properly (each secretary, MCC, other delegates, etc.) There are company internal and external tutorials for new delegates to assist coming up to speed.
There is a complete 'way of working' built around the tools that is well known and stable, including interactions between delegates and group leadership, submission, retrieval during and after meetings, databases to track actions, etc.
NOTE 1: There is a limitation to this benefit as institutional expertise in checking proper use of drafting rules is quite inconsistent amongst those who create and edit CRs. Additionally, features which appear to be simple, such as applying the correct style and verifying the correct style, ensuring the correct style when copying and pasting, and correctly applying changes with track changes turned on, are quite error prone.
2. Integration
(Nearly) all content for CRs and specifications are integrated into a single file that can be edited, viewed, sent to others, without any concern for capturing all of the content of the document (e.g. each figure). This makes it extremely easy to work collaboratively to incrementally collect feedback and share proposed changes on a document under discussion and revision.
NOTE 2: There is a limitation to this benefit, as continuing work and discussion of a CR involves multiple copies of the document (e.g. in the INBOX DRAFTS folder with only a manual effort approach to keep them in sync). Discussions on the basis of such divergent documents is difficult to follow.
Content can also be directly pasted into the document from external applications. For some formats, the metadata required to edit the figure is also included, e.g., MSC-Generator block diagrams and call flows include the image representation and the source representation when pasted into a document.
To the extent that there are other files needed, e.g. source code attachment in the form of YAML, JSON, XML, etc., these are collected in the same zip file that is used to store & retrieve, share and review, etc.
NOTE 3: There is a limitation to this benefit as the integration doesn't work well on all platforms. In particular, MSC-Generator (and any other format, e.g., Visio) diagrams embedded with OLE are not editable on any platform other than MS Windows and it may experience rendering issues when displaying. It shall be noted it is not only related to the OLE embedding but also the lack of programme/application for other OS.
3. WYSIWYG Editing and Ease of Use
The content of the document appears as it will in the final product. This view is exact when change marks are not shown.
When change marks are shown, the document is shown with close to final results, though the removed material is also displayed. Changes on changes, if shown at all, are used only for draft documents, removed in the submitted CR, but this is used in on-line work in some groups (see benefit 16 below).
NOTE 4: Changes on changes are not trivial to remove once introduced. 3GPP delegates, leaders and secretaries are familiar with this view and can work with it rapidly to identify what has changed and whether it is acceptable (especially, whether it addresses past comments). See Change Marking below.
WYSIWYG editing is easy to use. There is only one tool to learn for most editing tasks, (except for figure and equation editing, which can support use of external tools such as visio).
Also, WYSIWYG editing in the current tools allows editing directly in the document of content that has been embedded, such as equations, figures, diagrams, tables, etc. which is especially useful. This edited content appears at all times as it will in the final resulting version.
NOTE 5: There is a limitation to this benefit as MS Word is in fact a very complex software and even experienced delegates sometimes struggle with some of its features. Furthermore, when something goes wrong (in a large document with complex styles), it is extremely hard to figure out the source of the problem.
NOTE 6: Another limitation is that editing figures directly in the document embedded with OLE is not supported on any platform other than MS Windows and such figures may not render correctly. (See also NOTE 3 of benefit 2)
4. Proofing Tools
For many delegates English is not their primary language. For them, the spelling and grammar checks are quite helpful, as well as the automatic proposals for replacement of words and grammatical correction of phrases.
5. Change Marking
Change marks show added, removed, and moved text. They capture more than one change in a way that makes it immediately visible that changes are distinct. It is possible to view the metadata associated with the change (who did it, when, what the text of the change was, etc.)
It is possible to adjust the 'source' of the change marks, as this could be the name of the delegate, company, work item code, CR number, etc. in different ways of working scenarios, employed in 3GPP groups.
Additionally, draft specifications show change marks and a comment indicating from which CR submitted to plenary a change originated.
NOTE 7: There is a limitation to the benefit of change marking when applied to the task of implementing a CR in a specification on the basis of change marking, which has proven very difficult to automate.
NOTE 8: There is a limitation to the benefit of change marking as it does not capture some changes, especially details of changes to figures, tables and other more complex content. Some formatting changes are also not captured as changes. Removing empty lines can also result in unexpected behaviour such as applying the style of the text beneath the empty line to the text above the empty line once the empty line is deleted.
NOTE 9: There is a limitation to the benefit of change marking as track changing can be turned off, and changes can be discarded or accepted by any author without leaving traces.
6. Extensive Formatting
It is possible to format tables, figures, text, text colouring, and other content easily, with integrated help facilities to assist. Some of these operations are complex in principle (e.g. merging or splitting cells, greying parts of cells, etc.) though these are straightforward in terms of usability with the current tools.
NOTE 10: Highlight formatting is not strictly allowed by the drafting rules TR 21.801, but used extensively and found to be highly useful to emphasize certain changes in the drafting phase of a specification and for documents under discussion, etc.
NOTE 11: There is a limitation to this benefit as overly complex text formatting, which a document can end up with (sometimes inadvertently), significantly contributes to the slowness of editing and even viewing it.
7. Consistent Output
The current tools and formats have allowed 3GPP specifications to have a consistent appearance across thousands of publications, new and old.
8. Integrated means for collaboration
It is possible to embed comments (also known as 'comment bubbles') and replies to comments directly in documents. This is often used by participants in 3GPP to share their views during the revision and off-line discussion of documents. Though this is not used in any formal 3GPP document process, it remains a useful tool for organizations to share individual comments and questions both internally and externally.
Additionally, online collaboration is possible internally to a company during the drafting phase depending on the docx editing tool and file sharing system in place.
NOTE 12: There are limits to this benefit, as it does not scale up well to allow large numbers of comments or commenters.
NOTE 13: There is a limit to the way of working in which comments are shared in the form of documents with comments using ftp, email, etc. It is very difficult to coordinate this activity and keep track of all comments: either comments are collected in a single document which 'forks' unintentionally, or multiple documents must be collected and read without 'order' in the discussion (making it hard to properly reply to others' comments, be aware of all comments made, etc.)
9. Ability to control the page orientation
For tables that are very wide, it is very useful to reorient specific pages to landscape. This requires insertion of 'sections' in Microsoft Word.
10. Ability to capture significant common information in templates
Templates capture common styles, defaults, page width and height, headers, footers, etc. This makes it possible to achieve Consistent Output (see benefit 7 above).
NOTE 14: There is some limit to this benefit, since it is possible to ignore the template either through improper configuration of MS Word (e.g. the wrong language setting), or unintentionally, through pasting content into a document from a document with different properties and settings, that does not use the template, etc.
11. Product support and licensing
The current tools have professional support, are licensed and sold at reasonable prices globally and are sufficiently stable to work with. There are even (open source tool) options available that are compatible without licensing fees.
NOTE 15: There is a limit to this benefit, as some versions of tools used to read and write DOCX work slightly differently. In particular, embedded object editing support and Visio is only available on computers running Windows and such embedded objects may not be rendered correctly.
NOTE 16: The availability of some tools over time changes, and the affordability and stability of commercial tools depends on the perspective of the organization that participates in 3GPP.
12. Ease of conversion of format
It is easy to convert a MS Word document to PDF, among other formats.
NOTE 17: There is a limit to this benefit, as conversion to PDF sometimes fails (for reasons unknown).
13. Offline editing
Current tools and the associated file formats, principally MS Word and DOCX format files can be used off-line. TDocs and CRs can be downloaded in advance and read and edited locally.
14. Document navigation
Docx supports hierarchical headings which can be used by many docx editors to show an interactive table of contents for quick document navigation.
NOTE 18: There is a limit to this benefit, as large DOCX documents often need to be split into multiple files, which hampers navigation.
NOTE 19: There is a limit to this benefit, as the navigation requires proper application of header styles, which is not always the case for various reasons. (See benefit 6 above and also NOTE 5 of benefit 3 above)
15. Simple access to documents
Specifications and TDocs, including CRs, are easily accessible through a web portal and through an FTP client. Specifications are also available in a structured way, e.g., by series, which also lists all the version numbers per specification.
NOTE 20: For TDocs and CRs, this benefit is limited to the access, and the benefit falls short when searching for a specific document. That is, searching for the TDoc explaining the reason a change was made remains difficult. There is some disagreement about whether ftp use is 'simple' (it may be difficult to find a tdoc on the ftp file tree for past meetings, etc.)
NOTE 21: This benefit concerns the current 'document-centric way of working' in 3GPP and does not specifically relate to any document format, e.g. DOCX.
NOTE 22: The use of FTP is not allowed by some organizations as it is considered insecure.
NOTE 23: FTP is not the most efficient way to constantly synchronize a remote folder with documents (e.g. during a 3GPP meeting) to a delegate's computer. It requires constant manual downloading which takes time (sometimes a time of a chair during an online session to get the latest documents) and overloads the local network.
16. Ease of consensus building during meetings
During the meetings, both during online and offline sessions a lot of editing of the CRs happens whilst the changes are displayed directly on the screen. This is done by the chairs, rapporteurs, and offline moderators to capture comments made on the floor and to display the corresponding changes at the same time on the screen, including figures, equations, and tables. This is an important benefit of the current tools that improves meeting efficiency and is enabled by the WYSIWYG nature of the current tools.
NOTE 24: There is a limit to the extent that change marks can be captured on figures, equations, tables, etc. Change marking is not the benefit described above, rather collectively viewing and participating in editing sessions to reach consensus decisions on modified draft documents rather than already submitted documents.
17. Copy and paste content from CRs to other documents is possible. Chair notes, session notes, discussion papers, and other documents include content from CRs. It is beneficial to be able to reproduce the content of CRs with the same appearance in other documents easily. It is also beneficial (somehow essential) that the same format is used for CRs as specifications.
NOTE 25: There is a limit to this benefit, as the paste of content into a CR sometimes results in unexpected configuration and styles and other diverse formatting issues: MS Word will sometimes apply the style of the area being pasted into. The different options: keep source formatting; merge formatting; and keep text only are not always sufficient for maintaining the correct style, and are complex so easy to apply incorrectly.
18. The use of git brings benefits: testing of cross referencing across YAML files (text only) before publication. Cross referencing has proven beneficial also for the development of OpenAPIs. Use of 3GPP Forge hosting allows content (including OpenAPIs) to be stored without use of zip files.
NOTE 26: This is not the common practice in 3GPP as a whole as of now.
NOTE 27: There is a limit to this benefit, as it is only used by a few WGs. Tdocs that use solely DOCX format CRs do not benefit.
19. The use of Excel has proven useful for storage of large tables, which have proven problematic when included in DOCX files. It is also possible to include computation across multiple cells in the table, e.g. for test tolerances, measurement uncertainties and link budget calculations.
NOTE 28: This is not the common practice in 3GPP as a whole as of now.
NOTE 29: Storage of some content of CRs in a separate file eliminates benefit 2.
20. Macros for batch processing are beneficial, e.g. to identify style errors, editorial errors, in ASN.1 review for comment collection. Macros are also used for local document manipulation or concurrent manipulation of different documents.
NOTE 30: This benefit is present in MS Office applications, but the actual benefit is not the use of visual basic (which has disadvantages as a scripting language). Rather, the benefit is that there is a means to use scripts to process 3GPP documents, e.g. CRs, TRs, TSs and drafts thereof.
NOTE 31: There is a limit to this benefit, as VBA macros are not cross platform (many Word VBA features are not available on platforms other than MS Windows). Furthermore, some organizations prohibit using macros.
21. The ability to visualize different parts of a document (i.e. Split View) at the same time on the same screen is beneficial.
22. The ability to open and visualize several documents at the same time on the same screen is beneficial.
NOTE 32: One caveat to opening several documents at the same time is that with a popular docx editing tool, every window of the application is associated with all the others, so if one crashes, they all crash.
23. For their intended purpose in 3GPP, MS Office tools can be considered both natively secure i.e. robust to manipulation of source code, and systematically available (i.e. usable)
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 4.2 Shortcomings, pain-points and potential benefits
| Editor’s note: corresponds to objectives 1a/b
Table 4.2-1: Shortcomings, pain-points and potential benefits of current tools
#
Shortcoming / pain-point / potential benefit
Possible improvement approaches with current tools
Summary of feasibility of addressing the shortcoming / pain-point / potential benefit with current tools
Applicable WGs and users of the specification
1
Delays in specification availability Specifications are not available until after the TSG plenaries, sometimes very close to submission deadlines for the next WG meeting. Thus, writing new CRs is delayed or CRs are written based on an old version. There is also limited time for review of the merged spec.
Solution 1/1A - Increase workforce for CR merging
Solution 2 - Scripting to automatically merge CRs
Partly feasible - Solution 1/1A for decreasing the number of TSes handled by a single MCC officer with the caveat that even a single large specification with many CRs still takes time to handle, while there are drawbacks about redistributing the load from MCC to delegates who would take on some of the work. Solution 2 (maybe feasible) is being developed for ETSI, but its feasibility is unknown.
WGs
All groups
Users
Consumer, Contributor, Editor
2
CR cover page errors
Errors can be present in the cover page details such as specification number and version, date, release, CR revision, affected clauses, and changes are not reflected in database
Solution 3 - [New tool] CR conformance checking
Solution 4 - [New tool] CR auto-generation
Solution 5 - CR cover auto-generation
Maybe feasible - Solution 5 is available and can be useful if the cover page is generated and attached to the CR just before submission. Solution 3 is being developed for ETSI (new CR parser that will perform a number of verifications on CR cover fields and also verify that the clauses affected listed on cover correspond to the actual changes. The parser will be available on-demand and run upon CR upload). Solution 4 would solve the problem, but the tools do not exist.
WGs
All Groups
Users
Contributor, Editor
3
CR content errors
- Incorrect specification base text, e.g., from the incorrect version
- Errors introduced by copying and pasting content such as additional sections
- Errors introduced by copying a CR for a later release to mirror CRs for prior releases
- Unused references, e.g., references that are used but not defined, or defined which are not used, and references to non-existent clauses
- Incorrect use of styles, including manually applying text formatting to mimic a style
- Use of different settings in the docx editor such as language can lead to inconsistent formatting and styles which diverge from the official template
- Omission of trademarks, commercial references, etc.
Solution 3 - [New tool] CR conformance checking
Solution 4 - [New tool] CR auto-generation
Solution 6 - Restrict editing
Solution 7 - Training
Solution 8 - Light version of Microsoft Word
Solution 9 - EditHelp Consulting from ETSI
Solution 10 - Exhaustive analysis of docx files against 21.801
Not feasible - Solutions 4 and 8 require new tools, which need to be written. Today they are infeasible since they do not exist. Solutions 7, 9, and 10 resolve parts of the issues, and are already done today and we still have the problems.
Maybe feasible - Solution 6 could be feasible to resolve the style errors as long as everyone uses Microsoft Word.
Solution 3 is under development by ETSI in a new CR parser as indicated in solution 3 of shortcoming #2. The new CR parser will carry out a number of verifications, including use of latest reference version, no changes done without revision marks, or styles.
(NOTE 3)
WGs
All Groups
Users
Contributor, Editor
4
CR Merging
- Multiple changes to the same section sometimes remove specification text due to human errors.
- It is not possible to easily check the effect of the implementation of more than one CR or pCR simultaneously to check for side-effects
- It isn’t trivial to identify conflicting CRs such that the relevant experts, e.g., CR editors or WI rapporteurs, could discuss the appropriate resolution.
- Implementation of a CR is a manual process
Solution 2 - Scripting to automatically merge CRs
Maybe feasible - if the tool would be available for all specification contributors and editors, then it would be possible to check the effect of CRs.
A pilot tool by ETSI that detects CR clashes is currently in trial in some of the 3GPP WGs (e.g., CT3), This assists rapporteurs to facilitate resolution of clashes during the meeting rather than during CR implementation. Further development of the tool is in progress based on the feedback of the pilot
Furthermore, an automated CR implementation tool is being developed by ETSI.
WGs
All groups
Users
Contributor, Editor
5
CR Tracking
- It is difficult to associate a spec change with a CR, e.g., to determine where a change came from between two non-contiguous versions of a specification. For example, something changed between 18.1 and 18.7, but the exact version is unknown.
- CRs which are part of mega CRs or aggregate CRs are not visible individually in the draft spec.
- Changes to CRs to resolve merging conflicts, including those present in tables, ASN.1 definitions, and other text conflicts are not identifiable.
- Checking implementation of CRs is a manual process
- Missing background information on how certain test steps or approaches (pertaining to test parameters or implementation) were adopted for in conf test procedure
WGs
All groups
Users
Consumer, Contributor, Editor
5A
Feature Tracking
- It is difficult to track how a feature evolves across specification versions and releases. Furthermore, it is also difficult to track how corrections are introduced into a feature. This is particularly difficult for implementors who don’t reads a [new version of a] spec as a whole, but rather track how a particular feature evolves.
- Features are scattered across various sections of different TSs and the current tools don’t allow a way to “connect” those.
(NOTE 4)
WGs
All groups
Users
Consumer
6
Data Structure Styling, Syntax and Representation
- APIs and data structures, e.g., ASN.1, can contain formatting errors such as indentation for readability and colorization of keywords.
- Code-like and data model or table representations coexist and can be inconsistent, e.g., ASN.1, OpenAPI and XML in tabular form can be inconsistent and don’t match the code representations.
- OpenAPI: Different WGs (e.g. CT4 and SA5) often use the same datatypes but they are defined slightly differently.
- In some groups, when modifications are made during a meeting, syntax errors can be introduced due to lack of verification.
- In some groups, the contributions to the meeting can include syntax errors.
- It isn’t easy to extract code
Solution 11 - Externalization of APIs and data structures
Solution 12 - Single representation of APIs and data structures
Solution 13 - Automatic syntax checking
Feasible - Solution 11 is already used by some WGs to store certain data structures and APIs separately from the specification, e.g., RAN4, CT4, and SA5. Solution 12 is already used in RAN2 which moved away from tabular ASN.1.
Maybe Feasible - Solution 11 could be adopted. Groups such as RAN2 and RAN3 include field definitions and descriptions of conditionals in field tables. A solution for storing the field descriptions, which contain normative text, needs to be devised. Additionally, many find it convenient to have the procedures and protocol definitions in the same document.
Solution 13 would require new scripting to extract text from the specification and run the syntax checker.
WGs
All groups
Users
Consumer, Contributor, Editor
7
Cross-specification reference and navigation
- References to other specification documents are made using numbered references in square brackets and are sometimes accompanied by a section or clause number.
- Navigating across a work item over multiple specifications and working groups can be time consuming. For example, a RAN2 procedure could be triggered by RAN3 procedure, triggered by an SA2 procedure.
- Conformance Test specifications use heavy cross-referencing between the test spec (e.g. 38.521-1) and associated details in test point analysis (TR 38.905), MU/TT (TR 38.903), UE/UE connection diagrams (TS 38.508-1)
Solution 14 - Include the specification number and clause number in references
Solution 15 - Use hyperlinks in references
Solution 16 - Script to create, validate, and automate verification of cross-references between specifications
Partly Feasible - Solution 14 at least solves the problem of accurately referencing another specification or the same specification. This solution is both inconvenient and prone to errors.
Infeasible - Solution 15 - while feasible, links would be to zip files hosted on the 3GPP FTP server. These would have to be unzipped, which is inconvenient, and the reference could not be to a specific clause. This (links to a server) would not work offline, so the solution is infeasible. Solution 16 doesn’t exist.
WGs
All groups
Users
Consumer, Contributor, Editor
8
Figures can become impossible to edit
- Occasionally, CRs convert Visio figures to a format which cannot be edited. Sometimes Visio figures are drawn in an older format.
- MSC-Generator diagrams can become corrupt
Solution 17 - Store figure source files
Maybe feasible - Solution 17 is feasible in the current tools because figure source files could be attached in the zip files. However, specifications can contain dozens to hundreds of figures, which could lead to error in omission of files and could be unscalable. Additionally, each attached file would have to be individually opened.
WGs
All groups
Users
Contributor, Editor
9
Quality and size of figures
- Some specifications and TRs include many images or a large body of text which can contribute significantly to the size of a docx file, leading to high upload and download times.
- Figures are resized in dimension or compressed, thereby being distorted.
- Microsoft has disallowed usage of equation editor 3.0 due to security issues with equation editor. When opening equations that were originally written using equation editor are stored as rasterized pixel images. Such images have image distortion issues when resizing the scale of the view.
Solution 18 - Store images as vector graphics (SVG format)
Feasible - Solution 18 is feasible for non-equation graphics. There are available tools to edit files in SVG format, e.g. Inkscape (which is open source and freely available.).
WGs
All groups
Users
Contributor, Editor
10
Inconsistent use of tools and formats for figures
- e.g., Word, Visio, MSC-Generator, PlantUML, MS paint, PowerPoint, Equation editor, Latex, SVG, etc.
Solution 19 - Support a limited number of supported formats which work across WGs
Feasible - Solution 19 would consider tools supported by the overall specification format, so they would be compatible.
(NOTE 1)
WGs
All groups
Users
Contributor, Editor
10A
Use of non-cross platform tools
- Some specifications use tools and formats (e.g. Visio) which are not available on platforms other than MS Windows.
- All specifications include figures
Solution 17 - rely exclusively on native Word diagrams
Solution y - include source files separately
Solution 19 - stop using non-cross platform tools, use cross platform tools instead (svg editors)
Partly feasible - solution 17 is likely to reduce the capability to draw some diagrams, which may or may not be accessible, solution y is somewhat inconvenient but works.
Feasible - Solution 19 might result in a loss of features and look but the results using other tools can be similar. If the right tools are chosen, no local installation is needed. Some tools offer web based services, requiring a browser, only.
WGs
All groups
Users
Contributor, Editor
11
Large tables are not handled well - MS word does not handle large tables well and large documents well - can cause MS Word to crash or operate slowly.
Solution 11 - Externalization of APIs and data structures
Solution 25 - Split large specifications into smaller parts
Maybe feasible - Solution 11, depending on the nature of the table’s content, it could be externalized, e.g., as in RAN4 for Carrier Aggregation (table content stored in JSON files on the 3GPP FORGE, combined with companion tools for conversion, visualisation or export).
Partly Feasible - Solution 25 is used today, but it harms specification navigation, browsing and search.
WGs
All groups
Users
Consumer, Contributor, Editor
12
Collaboration on CRs
- Limitations of change tracking include: specific changes to figures are impossible to see; change marks not shown for columns deleted from tables; change marks are not shown when merging or unmerging cells; and change marks are shown in different colors, which poses an accessibility issue.
- Collaborative editing relies on downloading a document, providing input, and uploading it. There is a race condition when multiple delegates are working at the same time.
- Commenting bubbles do not scale well and having too many which affect the same clause makes it impossible to read.
- It is difficult to update documents when used to collect input since manual locking does not work and progress becomes slow and error prone
Solution 20 - Provide comments on CRs in a separate file instead of using bubble comments
Solution 21 - Use NWM to collect comments
Solution 22 - Extract text under review and use Git to manage reviews
Solution 23 - Use FTP to download latest inputs and upload new inputs
Solution 24 - Split the CR for review into multiple files
Infeasible - Solution 20 and 21 could become unscalable when commenting on a large CR with a large number of comments and responses. Solution 22 would cause the loss of content most likely and would result in an inaccurate review.
Maybe feasible - Solution 23 is used today, but many companies may be restricting access to FTP and SFTP.
Partly Feasible - Solution 24 could also work, but it has problems similar to Solution 23 and could increase confusion.
WGs
All groups
Users
Contributor, Editor
13
Specification opening and navigation delay
- Opening a TR or TS of 100s or 1000s of pages can take many minutes or even be impossible due to crashing.
- Searching with keywords can be slow.
- The specifications are stored as ZIP files, which add another step to opening the specification.
- There seems to be some issue in the .docx specification template itself, regarding the header that appears on top of each page which checking for every single page how the header should be filled even if there is only one outcome.
Solution 6 - Restrict editing
Solution 7 - Training
Solution 8 - Light version of Microsoft Word
Solution 11 - Externalization of APIs and data structures
Solution 25 - split large specifications into smaller parts
Solution 26 - Open specification and change to draft mode
Solution 27 - Produce 3GPP PDF version of the specification after each plenary
Solution 28 - Make all specs available in HTML
Solution 31 - Fix issues with page number and Header in published specifications
Infeasible: Solution 7: training does not preclude the possibility that Microsoft Word automatically applies styles, while training can draw people's attention on such matter and explain how to find erroneous styles and correct them.
Maybe feasible - Solution 6, Solution 8 could help solve the problem, but so far these have not resulted in faster loading specs. Solution 25 works but has downsides like lack of navigability. Solution 26 works once the document is open, but crashing can occur prior to being able to switch to draft mode. Solution 28 may be infeasible because the conversion of Word to HTML could be lossy.
Partly Feasible - Solution 27 is already done by ETSI and other SDOs, but 3GPP could possibly release a version more quickly. This may solve the issue for consumers, but not for contributors and editors (NOTE 2)
Feasible - Solution 11 would make the specifications smaller and rendered more quickly, by code or complex content (e.g. content of large tables converted to JSON+FORGE as currently considered in RAN4) outside of the specification docx file (external attachment or FORGE repository).
WGs
All groups
Users
Contributor, Editor
14
Numbering of PRs and CPRs
- Potential Requirements (PR), Consolidated Potential Requirements (CPR), requirements are numbered manually and inconsistently within TR/TS, making it error prone for tracking or later reference.
- In some groups, requirements are not numbered which makes reference to requirements very difficult - it must be done by copying the text of the requirement. This can become misaligned, if the text is corrected in the specification where it is a provision.
Solution 29 - Mandate the numbering of requirements (PR and CPR)
Feasible - In Solution 29, numbering just needs to be enforced.
15
Automatic processing of specifications
- Access from automated text processing tools, e.g., Automata, to CRs and TSs/TRs is very cumbersome, requiring a lot of preprocessing and manual intervention
The docx format is not easily processed. The file format is a mix of text and binary (to store images and objects). Conversions, e.g., docx to markdown, do not produce perfect representations of the original docx.
WGs
All Groups
Users
Contributor, Editor
16
Use of FTP
FTP is not the most efficient protocol for constant synchronization of folders, e.g. during meetings.
Solution x - a more modern and efficient tool and protocols (e.g. rsync) can be used instead of FTP
Maybe Feasible - solution x can be implemented.
WGs
All Groups
Users
Contributor, Editor
NOTE 1: This could also solve pain-point 8 depending on what is chosen.
NOTE 2: No solution has been provided for how to deal with ZIP files.
NOTE 3: It has been noted that some of the errors are due to not following the process. It should be considered which of these errors could be prevented by following rules and whether it is feasible to enforce the following of such rules.
NOTE 4: This is different from “CR tracking” as CRs deal with a resolution of a WI, not a feature.
Editor's Note: Solutions for #10A and 16 in Table 4.2-1 is to be elaborated with more detail (possibly with new rows) in Table 4.2-2.
Table 4.2-2: Possible improvement approaches with current tools
#
Possible improvement approaches with current tools
Pros of possible improvement approaches
Cons of possible improvement approaches
Implementation Feasibility Analysis
1
Increase MCC workforce for CR merging - In WGs where all CR merging is done by a single MCC officer today, there is the possibility to:
- Increase the MCC staff for CR merging.
Drastic decrease in the workload for MCC officers, reduces the need to look for automated tools for merging CRs into specs.
1A
Increase delegates workforce for CR merging - In WGs where all CR merging is done by a single MCC officer today, there is the possibility to:
- Offload this task to each spec rapporteur. 3GPP could provide regular training courses for delegates that are candidates to become TS rapporteurs.
Increase in workload for delegates. Need to ensure that all TS rapporteurs complete the task timely and respect all 3GPP drafting rules with proper and regular training.
2
Scripting to automatically merge CRs - ETSI is having a tool developed to automatically merge CRs into the specification.
Reduces human error and decreases the time to produce a merged specification.
It is unknown if such a script could be released to delegates and if it would comply with company security policies. For example, if macros are used, many would not be able to run them.
3
[New tool] CR conformance checking - write a new tool to check and report the location and nature of errors in a CR. These errors could include style errors, non-contiguous clause numbering, non-conforming figure and table numbering, and mismatches between the CR database and the CR cover page.
By using the tool pre-submission, delegates would not experience delays in submission and less time would be spent during meetings discussing styles and formatting.
It is difficult to write and maintain consistent tools based on docx due to high variability in docx file structures.
Ensuring that styles didn’t change between versions and ensuring that the correct approved styles are used could be challenging and encounter corner cases.
4
[New tool] CR auto-generation - Write a tool, e.g., an application-native script, Python script or other programming language-based tool to automatically create a CR from a modified version of a specification, including the following:
- Auto-filled cover page including the specification number, specification version, and affected clauses
- Automatic inclusion of affected clauses in the body of the CR, including change marks
- Additionally, the macro would need to be available for local use such that delegates could check their CRs prior to submission.
- Many error-prone fields of the CR cover page would be guaranteed to be correct.
- Style errors would be prevented
- The correct specification base text would be used
- Modifying additional clauses or removing affected clauses requires a regeneration of the CR
- Difficult to write and maintain consistent tools based on docx due to high variability in docx file structures
- Some companies do not allow the use of macros.
- This solution only works for the initial version of the CR.
5
CR cover auto-generation
The tool exists online at the time of reserving a TDoc for a CR.
The tool is only available for online use.
6
Restrict editing
The feature is available in current tool used for writing CRs and the specification.
This feature is not available in all docx editors. Furthermore, there is no way to enforce its usage.
7
Training - (1) correct use of styles
Some tools other than used for processing docx files may not allow delegates full control of the styles.
No training will help in the tendency of word applying styles etc. automatically.
(NOTE 2)
8
Light version of Microsoft Word - light version would include only features used in 3GPP without any additional feature, e.g. removing the possibility of adding new styles, and many other functions.
Removing most of Microsoft Word features should help reduce file sizes, ensure consistent use of styles and formatting, and may make automatic processing of compressed docs files easier.
Microsoft is not likely to create a custom version of Word for 3GPP.
9
EditHelp Consulting from ETSI - This is done before entering change control. After change control secretary review is possible but does not scale well.
Current rules require this
[In principle all authors must use official templates and settings. In practice, no one enforces this]
Forcing adherence to rules leads to slower progress. Those who did so were called CR police - respected, not loved.
This solution relies on accountability by contributors for repeated errors, but this is disrespectful in a professional setting. So this solution is not feasible.
[In principle all authors must use official templates and settings. In practice, no one enforces this]
10
Exhaustive analysis of docx files against 21.801
Issues would be discovered that are currently hidden.
This would have a very large impact on ways of working since authors would need to strictly use MS Word according to rules.
Assuming the proposal is to do this manually, this is hardly a feasible solution.
11
Externalization of APIs and data structures - APIs and data structures could be stored externally to the specification (e.g., Forge repository or external attachment).
- Standard text editors would take on the role of enhancing readability of APIs and data structures by providing colorization, indentation, and syntax highlighting.
- It would make the specs smaller and rendered more quickly.
- It would reduce errors in code/table content that arise from auto-processing feature of MS Word processor.
The specifications would be more difficult to search (considering some specs are currently split into multiple files, the difficulty of searching in multiple files is not new).
Field descriptions and procedures related to the APIs and data structures would be stored separately, requiring more careful checking (unless field descriptions become comments in the code, in which case the problem goes away).
Requires code to be separate from CRs, essentially (unless these are linked). This reduces CR specification cohesiveness.
12
Single representation of APIs and data structures - APIs and data structures could be limited to a single representation.
The need for specifying which version of an API or data structure is authoritative would be eliminated.
Some WGs include additional information, e.g., a tabular form of APIs and data structures and would need to devise a new way of capturing the additional information.
13
[New tool] Automatic syntax checking - Syntax checking
Reference checking, e.g., checking that a datatype of a parameter exists as an intrinsic to the language or as defined elsewhere in the API or data structure specifications.
The volume of CRs with syntax and consistency errors would be reduced.
Many errors cannot be identified without checking across all content associated with the entire target specification, or across multiple specifications.
14
Include the specification number and clause number in references - When available, include enough information to find the information referenced.
15
Use hyperlinks in references - manual process
Reader could immediately navigate to a reference without having to search each document.
The specifications are stored as zip files on the 3GPP server and in the 3GPP portal. If links were provided in the specifications, they would be to zip files, which would have to be downloaded, extracted and opened and therefore such solution cannot work offline.
16
[New tool] Script to create, validate, and automate verification of cross-references between specifications
Completeness and accuracy of references can be improved (if a solution is feasible).
If a solution is feasible, it will require extensive parsing of many specifications which may take time and may turn out to be prone to errors. Validation will be complex.
17
Store figure source files - For editable figures, store at least the source file, named in accordance with the figure number, alongside the specification.
- Standalone editors could be used to modify figures
- The figure source would never be lost.
- Because captions and headings are never reused, file naming consistency should be feasible.
- Any time a figure is edited, an extra step needs to be taken to ensure that the figure source file is updated.
- Errors could occur in naming of the source files.
- This disaggregation of content removes one benefit of the use of MS Word, namely that a single file contains all content in a simple way.
18
Store images as vector graphics
Scalable Vector Graphics (SVG) are scalable without distortion and are smaller in file size.
However, they are harder to edit manually (compared to e.g. MSC-gen or plantUML). There are tools available to edit SVG files, e.g. Inkscape.
19
Support a limited number of supported formats which work across WGs and platforms
Limited changes to the current way of working. MSC-gen, plantUML SVG and Mermaid are reasonable candidates. Additionally, native Word figures should be considered.
20
Provide comments on CRs in a separate file instead of using bubble comments
Using a separate WORD document for collecting comments is a widely used technique in WGs, and allows responding to comments efficiently
When using a draft FTP folder, comments from multiple delegates may collide in time and separate branches of the same file are created, which are then cumbersome to merge. Delegates have to carefully provide the reference to the clause and line of the spec they are commenting on.
21
Use NWM (or a professional web-based tool) to collect comments
Using NWM (or a commercial web-based tool) for collecting comments is a technique used by some TSGs/WGs.
Using NWM avoids collision of comments, but NWM is not convenient for commenting on equations or figures. Delegates have to carefully provide the reference to the clause and line of the spec they are commenting on.
22
[New tool] Extract text under review and use Git to manage reviews
This would help reviewing text-based large parts of specs where typically a large number of comments are received during the review of a draft TS. Delegates would be able to see spec text and provide a comment directly over that spec text without using another file.
This requires separating (during review time) some parts of the specs which are only text-based for separate commenting, since text-based file formats may not be suitable to parts of specs that contains other types of objects (equations, figures, etc).
23
Use FTP to download latest inputs and upload new inputs
It is based on existing tools.
Simultaneous editing and updating is not possible nor traceable. Coordination is very difficult.
24
Split the CR for review into multiple files - this can include splitting the ASN.1 from a spec like 38.331 for review.
It is based on existing tools and does help speed up work and reduces some contention.
Other problems are created, as changes to different parts of the spec can diverge. This approach does not scale to large files.
25
Split large specifications into smaller parts
Faster opening
Decreased locality of content, more difficult to maintain, read, browse, search, etc.
26
Open specification and change to draft mode
- Loading and editing times could be reduced.
- Change marks are still visible in draft mode
- It is more difficult to check bubble comments in draft mode
- Some document editing tools have been known to crash prior to being able to enter draft mode.
- Need to ensure correct insertion of figures in WORD so that they are still visible in draft view.
- essentially cancels many of WYSIWYG advantages
27
Produce 3GPP PDF version of the specification after each plenary
- Quicker access to a version of the specification which isn’t impacted by the slowness of some WYSIWYG editors.
- Processing for converting all WORD docs into PDF is done only once for each spec version,
- Cannot be used for producing CRs.
- Only helps spec consumers, not delegates and editors
- Need to ensure that conversion does not lose any information.
- Requires additional storage on FTP server.
28
Make all specs available in HTML
Faster opening, faster search.
Processing for converting all WORD docs into HTML is done only once for each spec version, presumably by MCC.
Cannot be used for producing CRs.
No navigation panel in html.
Need to ensure that conversion does not lose any information.
Requires additional storage on FTP server. Only helps spec consumers, not delegates and editors
29
Mandate the numbering of requirements (PR and CPR) - In some WGs, requirement numbering is done already. Maintenance of numbering is done the normal way - through careful alignment of provisions whenever they are introduced or corrected.
It is possible to refer to requirements without copying the text of the requirement. This reduces the risk of misalignment between specifications.
30
Include WI and meeting number with editor’s notes - For example, Editor’s Note: [FS_AIML-air_core, RAN2#129]
- It would be easier to find the delegate(s) responsible for the editor’s note
- It would be easier to identify stale topics to resolve.
- Slightly more work and introduces meeting-related details into the specification, which isn’t ideal. An alternative would be to find the CR which introduced the Editor’s note.
31
Fix issues with page number and Header in published specifications
- Publish specifications without Header and page numbers.
- Information contained in the Header (Release, 3GPP TS/TR number and version (year-month)) may be moved to the Footer, or included only on the first page.
When tested for TS38.331 with MS Word editor (Windows 11), issues with specification opening and navigation delay (shortcoming #13) disappeared. Re-pagination is very fast with solution 31.
Page number may no longer be available in published specifications. Note that page number would not be available if specifications were to be published in HTML. Providing page number is not essential.
Feasible
NOTE 1: Some improvements are essential for CR/meeting handling/discussions and some for improving specification/technical report (TS/TR) editorial quality and usage experience.
NOTE 2: This can hardly be considered a “tools improvement”
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 4.3 Requirements Identification
| Editor's note: corresponds to Objective 1c. The clause may be further divided into different subclauses depending on the discussion.
Table 4.3-1
#
Requirement
Description
Applicable to objective 2
Applicable to objective 3
Evaluation Criteria
1
Global availability
There shall be no geographic limitations on availability and usability of tools and formats.
Yes
Yes
Essential
2
Cost and licensing
Tools shall be available at reasonable cost.
Ideally, the use of open source and free tools (under reasonable licensing terms) should be prioritized, if possible.
Yes
Yes
Essential
3
Security and Availability
Tools shall be secure i.e. robust to manipulation of source code and shall be systematically available (i.e. usable) to avoid 3GPP coming to a halt.
Yes
Yes
Essential
4
Cross platform
It shall be possible to view and edit the specifications, including figures, on all major computer platforms (not necessarily including mobile platforms).
Ideally, online variants of these tools should be available (a.k.a. web-GUIs ).
Yes
Yes
Essential
5
Simplicity and learning curve
Tools shall be reasonably easy to use and should not cause significant change of the existing working procedures and/or drafting rules.
Yes
Yes
Essential
6
Limited number of tools and formats.
Specifications shall only require a limited number of approved formats and recommended tools.
Yes
Yes
nice to have
7
One reference
It should be possible to produce representations of the specifications in various formats suitable for different situations.
However, at the same time there shall be only one reference. The representation (i.e. reference output) should have consistent appearance to specifications of past generations.
Yes
Yes
nice to have
8
Fast opening, navigating and editing
Specifications shall be fast (no longer than 30 seconds on a reasonably modern computer even for large and complex specifications) to open.
Furthermore, there shall be no noticeable lag when searching, navigating or editing the specifications.
The tool shall be stable (no crashes) and shall not require splitting large documents into multiple files.
Yes
Yes
Essential
9
CR implementation
It shall be possible to quickly and easily (ideally automatically) implement a CR. This applies to both MCC and delegates (e.g. CR/TR rapporteurs).
A tool for automation of CR implementation should allow indicating the exact conflicts and allow specification rapporteurs to review and address such conflicts manually.
Furthermore, it should be possible to automatically detect CR conflicts (e.g. detect if multiple CRs propose changes to text in the same clauses, or the same text, or if a definition is changed for a term that is used in other CRs, etc). In all cases, human verification shall be possible before final approval of the merges of conflict resolutions.
Yes
Yes
Essential
10
CR Traceability
Specifications format and tools shall support an easy way for implementors to track introduction of requirements, new features and corrections to the existing ones.
The specification creation process shall allow recording all changes to the specification, including errors corrected during CR implementation.
Tools used for handling CRs (submission, revisions, agreement, rejection, etc) should allow that all decisions be traceable along with the reasons for decision.
Yes
Yes
Essential
11
Feature Traceability
The tools shall allow to document requirements, features and capabilities in a format that can be automatically parsed.
It should be possible (if feasible) to associate a requirement or a feature with the relevant text in all specifications which are related to the feature.
Yes
Yes
12
Cross-referencing and hyperlinking
It shall be possible to cross reference multiple specifications including (sub-)clauses. Such cross referencing shall be easy to navigate e.g. using hyperlinks. A specification shall be able to cross-reference another specification so that the referenced specification text is unambiguous. (NOTE 1)
Tools shall support hyperlinks, including:
- Internal (within the document)
- External (to other documents)
- Ideally, to specific clauses and sections within a document
- Ideally, using relative path (so that the link works anywhere provided the folder structure is maintained)
Yes
Yes
Essential
13
Tracking of Editor’s notes
It shall be possible to automatically track Editor’s Notes (EN) addition/removal/resolution (including the origin of the comment such as work item or contributing company), if ENs are used as an issue raising/resolving mechanism.
Yes
Yes
nice to have
14
References to discussion papers
It shall be possible to reference discussion papers (for background information) in CR cover page (or its equivalent in the new tool/format).
Yes
Yes
Essential
15
Automation
Specification format shall enable automation, e.g. to:
- Ensure consistent use of styles
- Extract ASN.1 (if in the new format ASN.1 isn’t stored separately)
- Extract table content for verification, usage and presentation.
- Extract text for verification, usage, and presentation.
- Generate content from other structured data e.g. schemas or JSON data.
- Automated alignment of bands/band configurations between RAN4 specs(e.g. TS 38.101-1/-2/-3) and RAN5 documents (e.g., Excel in PRD21)
- Automated alignment of the completion status of test cases between RAN5 test cases specs (e.g. TS 38.521-1/-2/-3/-4/-5, TS 38.533) and applicability specs (e.g. TS 38.522)
Yes
Yes
16
Specification browsing
It shall be possible to search and navigate within and across specs via both online and offline versions.
It shall be possible to select the exact release and version of a TR or TS to access.
Yes
Yes
17
CR drafting during and in between meetings
It shall be possible to handle the process of drafting a CR involving a large number of contributors who provide a large number of comments and propose a large number of changes. It shall be possible to trace changes and comments to the individual contributors.
CR handling needs to work for normal and electronic meetings, where either only one author can provide revisions or multiple authors from different companies can provide revisions and add comments during the meeting. For the latter scenario, tools shall also support the handling of concurrent revisions by different authors of the same document in order to prevent inconsistent revisions.
(NOTE 7)
Tools need to also work before and after meetings for collaborative work between source companies preparing input documents.
(NOTE 2)
Yes
Yes
Essential
18
Collaboration on CR drafting between companies
Sharing of draft CRs within and between the source companies for preparing input documents shall be possible.
Yes
Yes
Essential
19
Consistent access to CRs and specifications
The tools should allow 3GPP delegates to access CRs and specifications in a similar way as today during pre-meeting, post-meeting and online meeting.
Yes
Yes
Essential
20
Visual representation of changes
Tools shall allow visual representation of the changes in a CR and between the original spec and the revision.
The author, i.e., at least the source company, of proposed changes should be visible.
The effects or changes imposed by a CR should be easily readable and navigable such that all the changes can be viewed in the context of the clause affected.
Yes
Yes
Essential
21
Supported styles
Tools shall support the following styles:
- Headings - Heading 1, Heading 2, up to Heading 6
- Hyperlinks - Internal and external
- Lists (bulleted)
- Lists (hierarchical)
- Lists (numbered) (NOTE 3)
- Tables (simple cell contents; allows different justification {left, center, right})
- Table (column header contents)
- Table of contents
- Text bolding (or equivalent highlighting)
- Text italicization (or equivalent highlighting)
- Text subscript
- Text superscript
- code (in the case code is not stored separately in its native format)
- symbols (non-alpha-numeric characters), non-breaking spaces and hyphens
- Notes
- Editor's Notes
- Table footers
- Table headers
- References
- Equations
Ideally, there should be a way to preclude usage of styles not listed above. In particular, complex tables shall be avoided. Excerpted text from other languages than English (e.g. in references or examples) should also be supported where necessary.
Yes
Yes
Essential
22
Supported objects
Tools shall support:
- Figures (e.g. block diagrams, call flow diagrams, images)
- Equations (inline and block).
Yes
Yes
Essential
23
Seeing output while editing
The tool shall support the ability to view the content of (part of a specification) in the form in which it will be published (as a specification), including tables and diagrams while and after editing.
No
Yes
Essential
24
Offline work
The tool shall support the ability to read and edit specifications and CRs and to verify CRs offline, in particular to allow private editing before submission.
Yes
Yes
Essential
25
Meeting decisions and reports (meeting minutes)
Tools shall support tracking decisions of the following: CR, draft CR, pCR, TS, TR with Tdoc numbers in meeting reports.
Yes
Yes
Essential
26
Public access to specifications and CRs
Tools shall allow easy access to CRs and Specifications to the larger community, including those who do not actively participate in 3GPP, via both online and offline versions.
The specifications shall be convertible to PDF for publishing.
Yes
Yes
Essential
27
Fault tolerance
Tools and working methods should have reasonable fault tolerance against minor human errors. Corner cases should be manageable. The specification creation process should aim to minimize the possibility for human errors.
Yes
No
Essential
28
Consistent appearance
New specifications (for 6G) need to have a consistent appearance and quality, similar to previous generations.
Yes
Yes
29
Supported style functions
A delegate, MCC rapporteur shall be able to highlight text, to draw attention to it, even though highlighting is not allowed in the drafting rules and cannot be in an approved CR.
A delegate, MCC rapporteur shall be able to remove all formatting from text.
A delegate, MCC rapporteur shall be able to view non-printing characters (non-breaking spaces, tabs, new lines, page breaks, etc.) if these are added to the content of the CR.
Yes
Yes
Essential
30
Comments
It shall be possible to associate a comment with specific provisions (e.g. a paragraph, single word, figure, etc.) of any CR. This comment includes comment text, the identity of the commenter and the time in which the comment was provided.
It shall be possible to remove or 'disassociate' comments with text in a CR.
Yes
Yes
Essential
31
CR format
CRs using the new specification format for 6G should support visual emphasis of modified sections, be compatible with file formats acceptable for submission to 3GPP meetings, and allow for seamless transfer of the proposed changes into discussion papers as Text Proposals
Yes
Yes
Essential
32
CR cover pages
The tool shall support CR cover page (or its equivalent in the new tool) checking (e.g. no dates in the future, CRs to specifications that don't exist, the other specs affected tick boxes are neither yes nor no, and so on).
The tool shall also support automatic generation of CR cover pages (where possible).
The tool shall also support reviewing, editing and commenting on CR cover pages during CR review process.
Yes
Yes
Essential
33
Code
The tool and formats shall support code (e.g. ASN.1).
If code is in the same document as the CR/TS, there should be a means to extract the code portions from the technical specification so that the code can be used as input to machine processing (e.g. an interpreter, compiler, etc.)
Code that is part of a CR/TS should be able to be checked for syntax errors, and compile time errors.
Code that is part of a CR should be able to be checked in combination with other code provided in the specification, to determine if there are redundancies, mismatches, etc.
Yes
Yes
34
Support review of figures
Every change to a figure shall result in a 'change marking' visible, indicating what changed and who made the change.
(NOTE 4)
Yes
Yes
35
Support consistent common configuration
It shall be possible to enforce simple and consistent configuration for users, so that errors arising while creating, editing and cut-n-pasting due to inconsistencies are rare or impossible.
(NOTE 5)
Yes
Yes
Essential
36
CRs comprising multiple files
The tools shall support (if needed) CRs comprising multiple files in simple and consistent order (i.e. as separate documents stored in a mandatory way for the associated CR or specification).
Yes
Yes
Essential
37
CR database
Changes to CR documents (including headers and content) shall be automatically captured in CR databases to ensure the correct correspondence between an approved and implemented CR and the CR database.
Yes
Yes
38
Support for gathering input on a CR
The tool shall support gathering input on a CR or its content for highly active topics involving many participants, without divergence in the process.
Use of tools to collect comments and feedback shall enable orderly capture of responses, so that the order, source and input from each reviewer is captured without ambiguity or loss. This facility shall scale up to 100s of active reviewers posting 1000s of comments a day.
(NOTE 6)
Yes
Yes
Essential
39
Simplicity to follow drafting rules
The tool shall enable editors not to be concerned with styles, but rather with the technical content and its hierarchy in the document.
Yes
Yes
40
Support for visualizing different parts of a document concurrently on the same screen
The tool shall enable visualizing different (incl. disjoint) parts of the same document concurrently on the same screen similar to Split View in MS Word.
Yes
Yes
Essential
41
Support for visualizing different documents concurrently on the same screen
The tool should enable visualizing different documents concurrently on the same screen.
Yes
Yes
Essential
42
Support for personal scripts
The tool should enable delegate, consumer, MCC/Rapporteur to develop and use their own scripts to manipulate a document locally or together with other documents (similar to MS Office Macros).
Yes
Yes
Essential
43
Language proofing
The format shall allow checking a document for errors in spelling, grammar, and punctuation, and ensuring it adheres to the rules of the English language.
Yes
Yes
Essential
44
Folder synchronization
The tools shall support an easy, fast and efficient way to synchronize folders
Yes
Yes
nice to have
45
Mathematical calculations
The tool should enable calculation across multiple inputs, similar as the Excel Formula function. This is important for RAN5 to deriving test points, test tolerances, and measurement uncertainties.
Yes
Yes
46
Transposition
Regardless of the format or the tool adopted, there shall be a specification output for each specification version such that the Organisational Partners have a reference to build an unambiguous human readable transposed standard for any interested party.
Yes
Yes
Essential
47
Access to 3GPP specifications by external stakeholders
Regardless of the format or the tool adopted, the 3GPP specifications and the evolution of them shall be accessible by diverse types of stakeholders in the industry. That is, the history of the changes and the specifications themselves can be viewed by the stakeholders in a human readable manner in a self-contained environment (e.g., file).
Yes
Yes
Essential
NOTE 1: For example, conformance test specifications use heavy cross-referencing between the test spec (e.g. 38.521-1) and associated details in test point analysis (TR 38.905), MU/TT (TR 38.903), UE/UE connection diagrams (TS 38.508-1) which are critical for implementation of the test however difficult to maintain with manual effort.
NOTE 2: The tool should improve upon the process used today.
NOTE 3: Lists can be indented to different levels, e.g. to allow sub-bullets.
NOTE 4: The granularity of the change marking is at least 'the figure has changed.' Greater granularity than that, e.g. highlighting changes in text in a figure, is considered Very Nice To Have.
NOTE 5: This addresses the problem with current use of MS Word where the configuration of the tool is frequently inconsistent and hard to control, leading to poorer CR and specification quality.
NOTE 6: The comments and related information that are gathered can be removed or are not intrinsically part of the CR or specification.
NOTE 7: It is desirable to have only a single sequence of revisions (in that case, different authors would not be able to make changes at all times), but alternative solutions may be considered.
Editor’s note: A “tool” is used as a generic term and need not imply there is a single tool that meets all the mentioned requirements.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5 Proposals for new formats for 3GPP specifications
| Editor's note: corresponds to objective 2.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.1 Proposal #1: OpenDocument
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.1.1 Description
| OpenDocument (ODF) is an open, XML-based file format family for office documents, established as an international standard (ISO/IEC 26300). It's free, transparent, and not controlled by any single vendor. Most importantly, it is a standardized format) which allows to develop tools to automate virtually any task. The ITTF has added ISO/IEC 26300 to its "list of freely available standards"; anyone may download and use this standard free-of-charge under the terms of a click-through license.
The OpenDocument Format (ODF) includes the following main document types:
- Text Documents: .odt (like Microsoft Word's .docx)
- Spreadsheets: .ods (like Microsoft Excel's .xlsx)
- Presentations: .odp (like Microsoft PowerPoint's .pptx)
- Graphics: .odg (for vector graphics)
- Charts: .odc
- Formulas: .odf
- Master Documents: .odm
OpenDocument is an XML-based format with a standardized file structure illustrated below:
├── mimetype # File type identifier
├── META-INF/
│ └── manifest.xml # File listing
├── content.xml # Actual content
├── styles.xml # Formatting styles
├── settings.xml # App settings
├── meta.xml # Metadata
└── Pictures/ # Embedded media
In a properly structured ODF file, content (included in content.xml file) is separate from styles (included in styles.xml).
It is important to note that ODF is a very rich format with feature parity to DOCX, and therefore in theory it is prone to the same misuse that we sometimes see in DOCX standards documents. However, it is possible to agree and more importantly enforce the usage of a limited subset of the ODF features.
The proposal is to use a limited set of ODT styles and features, to strictly ensure through the use of automatic tools compliance with such restricted ODT format and to develop tools to automate common delegate, rapporteur and MCC tasks.
In particular, the following ODT restrictions should be enforced:
- No “automatic styles”, i.e. “content.xml” file should only contain content - not styles
- “styles.xml” should not be modified, i.e. it should be controlled by MCC
- Only specific embedded media formats should be allowed
- There should be a size limit for a single ODT file, larger files should use “master and subdocument” feature
- Only simple tables should be allowed
- Code (e.g. ASN.1) should be stored in a separate file (this is optional, but useful)
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.1.2 Figures, Diagrams and Embedded Objects
| OpenDocument supports basic shapes, as follows:
- Basic geometric shapes (Rectangles, Ellipses and Circles, Lines, etc)
- Polygons, and paths (Polylines, Polygons, Freeform Lines and curves, etc)
- Special-purpose shapes (Text boxes, Block arrows, Stars, Callouts, etc)
- And some others
However, the shapes supported “out of the box” are rather limited (compared to MS Word).
OpenDocument does support Custom Shapes, however they are rather hard to handle.
Furthermore, OpenDocument (and LibreOffice) support Object Linking and Embedding (OLE), which allows to include embedded objects of various kinds, including Visio and MSCgen. However, this only works on Microsoft Windows and therefore cannot be used as it would violate the cross-platform requirement.
Therefore, the only viable option appears to be to store images (e.g. in SVG, PNG, or any other format) externally (e.g. in a separate folder) and link to those images in the document. Such images can be generated (by external tools) from MSC, PlantUML, Mermaid and others. The downside is that both the “source” (e.g. in PlantUML) and the result (e.g. SVG image) must be maintained, together with the .ODT document.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.1.3 Master Document
| An ODT master document is a special file type, with the extension .odm, used to organize and manage a large, multi-part document. The master document acts as a central container that links to separate .odt files, known as subdocuments.
The master document does not hold the content of the subdocuments directly. Instead, it pulls them together. This way, subdocuments can be edited separately (to facilitate speed), but the whole document can be viewed together (to facilitate search and ease of use for implementors).
This is illustrated in Figure 5.1.3-1 below
Figure 5.1.3-1: OpenDocument Master illustration
Unfortunately, this feature appears to be rather unstable (e.g. sometimes the formatting of the document when viewed “as a whole” through a master document doesn’t match the formatting of the .ODT file included in the master). Therefore, the usefulness of this particular OpenDocument feature for our purpose is limited.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.1.4 Flat XML format
| An OpenDocument flat XML file is a version of an OpenDocument Format (ODF) document that is saved as a single, uncompressed XML text file. It is an alternative to the standard ODF files (like .odt for text) which are typically saved as a compressed ZIP archive containing several XML and media files.
The "flat" version of the file uses the .fodt extension for text documents, .fods for spreadsheets, and .fodp for presentations.
However, considering the size of our specification and the complexity of the resulting flat XML file, the usefulness of this particular OpenDocument feature for our purpose is limited.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.2 Proposal #2: AsciiDoc
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.2.1 Description
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.2.1.1 Overview
| References below provide extensive descriptions of AsciiDoc, which we don’t intent to fully copy here:
- https://asciidoc.org/
- https://asciidoc-wg.eclipse.org/
- https://gitlab.eclipse.org/eclipse/asciidoc-lang
- https://projects.eclipse.org/projects/asciidoc.asciidoc-lang
- https://docs.asciidoctor.org/asciidoc/latest/
References above state that the AsciiDoc Working Group drives the standardization, evolution, and adoption of the AsciiDoc® language through open collaboration and open source, as part of the Eclipse Foundation, which provides individuals and organisations with a mature, scalable, and vendor-neutral environment for open source software collaboration and innovation. The AsciiDoc Language and the accompanying materials are made available under the terms of the Eclipse Public License v 2.0 (EPL-2.0). The user documentation for the AsciiDoc Language, located in the docs/ folder, is made available under the terms of a Creative Commons Attribution 4.0 International License (CC-BY-4.0).
Until the first version of the AsciiDoc Language Specification is ratified, AsciiDoc is defined by the Asciidoctor implementation. There is no other official definition of the language. The user documentation from the Asciidoctor project is not the AsciiDoc Language Specification, but serves as the reference material from which the AsciiDoc Language Specification will be developed. At the time of writing, the latest version available was Asciidoctor 2.0.20, released on 2023.05.18.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.2.1.2 Features of AsciiDoc
| A list of features supported by AsciiDoc is summarized in Table 5.2.1.2-1. The full list of features supported by AsciiDoc and more details on the summarized features can be found at https://docs.asciidoctor.org/asciidoc/latest/. Table 5.2.1.2-1 also provides the comparison with the language used in MarkDown.
Table 5.2.1.2-1: Features of AsciiDoc
Feature
AsciiDoc
Notes on AsciiDoc
Markdown (for comparison)
Heading
= Document Title (Level 0)
== Level 1 Section Title
=== Level 2 Section Title
==== Level 3 Section Title
===== Level 4 Section Title
====== Level 5 Section Title
== Another Level 1 Section Title
When the document is converted to HTML 5 (using the built-in html5 backend), each section title becomes a heading element where the heading level matches the number of equal signs. For example, a level 1 section (==) maps to an <h2> element.
# Heading 1
## Heading 2
…
###### Heading 6
Image
image::target[]
or
image:target
AsciiDoc image macro types:
block form uses two colons (::)
inline form only uses one (:).
target may be a relative path or a URL.
Link
https://www.asciidoctor.org.
or
https://asciidoctor.org[]
AsciiDoc recognizes the common URL schemes (http, https, ftp, irc, mailto) without the help of any markup.
Escaping possible with single backslash (\) in front of a URL.
[text](path)
List (Ordered)
[start=4]
. Step 4
. Step 5
.. Step 5a
.. Step 5b
. Step 6
It is possible to number the ordered list explicitly instead of using ‘.’, as long as the list numerals are sequential.
1. Item 1
2. Item 2
List (Unordered)
* Level 1 list item
** Level 2 list item
*** Level 3 list item
No indentation needed in AsciiDoc
- Item 1
- Item 2
- Sub Item 2-1
Text Decoration (Bold)
*text*
Example: text
**text**
Text Decoration (Italic)
_text_
Example: text
*text*
Text Decoration (Bold+Italic)
*_text_*
Example: text
***text***
Subscript
base~lower~
Example: baselower
base~lower~
Superscript
base^upper^
Example: baseupper
base^upper^
Table
[cols="1,1"]
|===
|header in column 1, row 1 |header in column 2, row 2
|Cell in column 1, row 2
|Cell in column 2, row 2
|Cell in column 1, row 3
|Cell in column 2, row 3
|===
Insert an empty line after each row.
Columns with different widths are supported.
A cell can span multiple rows.
AsciiDoc block elements and macros can be nested in a cell of a table
| Header 1 | Header 2 |
|------------|-------------|
| Cell 1-1 | Cell 2-1 |
| Cell 1-2 | Cell 2-2 |
Or
+----------+----------+
| Header 1 | Header 2 |
+==========+==========+
| Cell 1-1 | Cell 2-1 |
+----------+----------+
| Merged Cell 1 |
+---------------------+
Equation (Block)
[stem]
++++
sqrt(4) = 2
++++
or
[asciimath]
++++
sqrt(4) = 2
++++
AsciiDoc language supports embedding math-mode macros from LaTeX and/or AsciiMath notation as block elements.
Set the stem attribute in the document’s header :stem: (which sets AsciiMath by default) or :stem: latexmath
C(x,y)=\left \{
\begin{align*}
\begin{pmatrix} x \\ y \end{pmatrix} & x \geq y \\
0 & x < y
\end{align*}
\right.
Equation (Inline)
stem:[[[a,b\],[c,d\]\]((n),(k))]
or
latexmath:[C = \alpha + \beta Y^{\gamma} + \epsilon]
See above
that satisfy $k_{l,i}^{(1)} > 0$, $i \neq i_{1,3,l}$, as
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.2.1.3 Tools for AsciiDoc
| AsciiDoc syntax is plain text, so one can write an AsciiDoc document using any text editor. GitHub and GitLab support editing and previewing AsciiDoc files. The file must have a supported AsciiDoc extension (.adoc). When viewing an AsciiDoc file on these sites, one sees an HTML preview of the AsciiDoc content. In edit mode, one can modify the source of the AsciiDoc file and see a preview of the modified source before committing changes.
Several IDEs and text editors support the AsciiDoc syntax and most provide document preview rendering with Asciidoctor: AsciiDocFX (editor and terminal emulator written with JavaFX 8), Visual Studio Code, Eclipse, etc.
One can convert AsciiDoc to HTML with a command line calling the Asciidoctor processor: $ asciidoctor filename.adoc. It is possible to apply a custom stylesheet.
One can convert AsciiDoc to PDF using the asciidoctor-pdf command-line tool. For converting to PDF, it is required to have Asciidoctor PDF gem installed and available on the Ruby runtime path.
This first requires installing Asciidoctor. Asciidoctor operates on Linux, macOS, and Windows and requires one of the supported Ruby implementations. Asciidoctor is packaged as a gem and published to the gem hosting service at RubyGems.org. The gem install command is recommended for Windows users. Asciidoctor is also distributed as a managed package for popular Linux distributions and macOS. In addition to running on Ruby, Asciidoctor can be executed on a JVM using AsciidoctorJ or in any JavaScript environment (including the browser) using Asciidoctor.js.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3 Proposal #3: Markdown
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1 Description
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.1 Introduction of Markdown
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.1.0 General
| Markdown was created by John Gruber in 2004 as an easy-to-read markup language. Popularity of Markdown eventually led to a number of implementations. The original Markdown language had ambiguities that did not get addressed and a group of people has made attempts to standardize the markup language in 2012. This is known as CommonMark and widely accepted as basic specification for Markdown language.
Several different websites have adopted CommonMark but have added their own flavour of the syntax to further extend the Markdown language, which are known as Markdown variants. Some notable Markdown variants are GitHub Flavored Markdown (GFM), MultiMarkdown (MMD), PHP Markdown Extra, R Markdown, GitLab Flavored Markdown (GLFM), and Pandoc variant of Markdown.
Markdown is the language used by Wikipedia to write articles. The language is simple and focused on information rather than on formatting. To that end, the language supports a small number of critical features which easily translate into HTML, the target format for conversion from Markdown. From HTML, a further conversion to PDF is supported for publishing. This section will describe the base features of Markdown, extensions to Markdown, and custom processing which was developed to support specific aspects of 3GPP specifications during the research for this solution.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.1.1 Comparison of common Markdown variants
| As stated in the previous section, there are many variants of Markdown with support for different sets of basic and extended features. Table 5.3.1.1.1-1 compares Commonmark, Gitlab-flavoured Markdown, and Pandoc Markdown, albeit not exhaustively. A cell containing an X indicates support, while an empty cell indicates lack of support.
Table 5.3.1.1.1-1: Comparison of selected Markdown variants
Feature
Commonmark
Gitlab
Pandoc
Block Quote
X
X
X
Code Block
X
X
X
Heading 1 - Heading 6
X
X
X
Horizontal Rule
X
X
X
Image
X
X
X
Inline Code
X
X
X
Link
X
X
X
List - Numbered
X
X
X
List - Unordered
X
X
X
Text - Bold
X
X
X
Text - Italic
X
X
X
Diagram - Mermaid
X
Diagram - PlantUML
X
Inline HTML
X
X
Inline HTML with Embedded Markdown
X
X
LaTeX Equation - Block
X
X
LaTeX Equation - Inline
X
X
Table - Grid Table
X
Table - JSON Tables
X
Table - Pipe Table
X
X
The details for Commonmark can be found at https://commonmark.org/help/. The details for Gitlab-flavoured Markdown can be found at https://docs.gitlab.com/user/markdown/. The details for Pandoc can be found at https://pandoc.org/MANUAL.html#pandocs-markdown.
Editor’s note: For the purpose of the study, Pandoc Markdown has been used until this point. However, depending on what is discovered during the development of the prototype, other variants could be considered. Note that custom extensions have not been described in this section.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.2 Benefits of Markdown
| As described in the previous section, Markdown separates information from styles. A major pain point with the way specifications are written in 5G is that it is difficult to properly select styles and that time is wasted on non-technical work. Markdown has the potential to solve this challenge to writing the specifications and the p/CRs to the specifications, which is using and maintaining the correct styles. Styles are eventually applied to the HTML file, resulting from the conversion from Markdown, through the use of Cascading Style Sheets (CSS), which can be used to apply fonts, font sizes, font colours, list styles, table header styles, and more. An additional benefit of applying styles in this manner is that it is easier to maintain a consistent appearance throughout the specifications.
A second benefit of Markdown is that the format is purely plaintext and sequential, which is required for use with modern version control tools. A docx file is different in that it is a zip file containing multiple XML files and resources such as images and different filetypes supported by docx. Prior to being extracted or opened, a docx file is a binary file, incompatible with modern version control tools. In order to compare between two version of the same document, it is necessary that the text is human-readable. The sequential nature of the Markdown file makes it simpler to identify changes because they will be localized.
A third benefit is increased performance of editing tools. When editing plaintext Markdown without rendering or preview, text editors work efficiently without crashing. There are many options for text editors, including Microsoft Visual Studio Code, Notepad++, Notepad, Emacs, and many others, depending on the user’s preference. Even with large specifications, the performance is high because fonts and images do not need to be rendered and pagination is unnecessary.
Given the wide adoption of Markdown, there are a variety of methods to preview a rendered version of the Markdown file. One example from Microsoft Visual Studio Code, a free tool, is shown in Figure 5.3.1.2-1 below.
Figure 5.3.1.2-1: Markdown preview in Visual Studio Code
The sections that follow describe the base features of Markdown, commonly used extensions to Markdown, and custom 3GPP extensions to Markdown using Pandoc. Then, the high-level process to convert from Markdown to HTML and PDF will be described.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.3 Base features of Markdown
| Markdown without extensions supports the following base features, described in Table 5.3.1.3-1. These features apply to the blocks named “Source” and “Images” in Figure 5.3.1.62-2. The table names each feature and demonstrates the Markdown and HTML syntax. Because the rendered output of Markdown is represented in an HTML file, an image of the rendered output is provided in the HTML column.
Table 5.3.1.3-1: Basic features of Markdown
Feature
Markdown
HTML
Notes
Heading
# Heading 1
## Heading 2
…
###### Heading 6
<h1> Heading 1 </h1>
<h2> Heading 2 </h2>
…
<h6> Heading 6 </h6>
Limited to 6 levels. A style specific to each heading level can be applied through CSS, which enables different font sizes for each heading as shown in the example.
Image
<img src=”path” />
Path is the destination, i.e., the image being pointed to, e.g., fig_5.3X.1.2-1.svg.
Link
[text](path)
<a href=”path”>text</a>
Text is the text which would be presented as a clickable link, and path is the destination, i.e., the page or resource being linked, e.g., path.html.
List (Ordered)
1. Item 1
2. Item 2
<ol>
<li>Item 1</li>
<li>Item 2</li>
</ol>
List (Unordered)
- Item 1
- Item 2
- Sub Item 2-1
<ul>
<li>Item 1</li>
<li>Item 2</li>
<ul>
<li>Sub Item 2-1</li>
</ul>
</ul>
The bullet style is set by the HTML stylesheet.
Text Decoration (Bold)
**text**
<strong>text</strong>
Example: text
Text Decoration (Italic)
*text*
<em>text</em>
Example: text
Text Decoration (Bold+Italic)
***text***
<strong><em>text</em></strong>
Example: text
Indentation
> text
text
Indentation can be used for NOTE and Editor’s Note
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.4 Extended features of Markdown
| Markdown has been extended to add more features such as equation rendering, superscript and subscript, and grid tables, which enable tables with merged cells. Many popular extensions exist, including Pandoc-flavoured Markdown (https://pandoc.org/MANUAL.html) and GitLab-flavoured Markdown (https://docs.gitlab.com/user/markdown/), but the Pandoc-flavoured Markdown was chosen for explanation of extended features of Markdown due to its general compatibility with other popular versions of Markdown and its use by Pandoc, the tool selected for converting between Markdown and HTML for the example production process of the rendered document. Table 5.3.1.4-1 describes extended features of Markdown which could be useful in 3GPP specifications.
Table 5.3.1.4-1: Extended features of Markdown
Feature
Markdown
HTML
Notes
Equation (Block)
C(x,y)=\left \{
\begin{align*}
\begin{pmatrix} x \\ y \end{pmatrix} & x \geq y \\
0 & x < y
\end{align*}
\right.
MathML Conversion (not shown) or Image
Equations are written in the Latex format.
MathML not shown due to complexity and would not be directly entered or edited.
The block equation is entered between $$ and $$ and line breaks in the equation are supported.
Equation (Inline)
that satisfy $k_{l,i}^{(1)} > 0$, $i \neq i_{1,3,l}$, as
MathML Conversion (not shown) or Image
Equations are written in the Latex format.
MathML not shown due to complexity and would not be directly entered or edited.
The inline equation is entered between $ and $ without any line breaks in the equation.
Subscript
base~lower~
base<sub>lower</sub>
Example: baselower
Superscript
base^upper^
base<sup>upper</sup>
Example: baseupper
Table (Simple) – Pipe Table
| Header 1 | Header 2 || Header 1 | Header 2 |
|----------|----------||------------|-------------|
| Cell 1-1 | Cell 2-1 || Cell 1-1 | Cell 2-1 |
| Cell 1-2 | Cell 2-2 || Cell 1-2 | Cell 2-2 |
<table>
<thead>
<tr>
<th>Header 1</th>
<th>Header 2</th>
</tr>
</thead>
<tr>
<td>Cell 1-1</td>
<td>Cell 2-1</td>
</tr>
<tr>
<td>Cell 1-2</td>
<td>Cell 2-2</td>
</tr>
</table>
This type of table supports word-wrapping in cells and supports multi-line cells with manual break tags (<br>). Merged cells are not supported.
Table (Complex) – Grid Table
+-------+----------+------+
| Table Headings | Here |
+-------+----------+------+
| Sub | Headings | Too |
+=======+==========+======+
| cell | column spanning |
+ spans +----------+------+
| rows | normal | cell |
+-------+----------+------+
| multi | cells can be |
| line | *formatted* |
| | **paragraphs** |
| cells | |
| too | |
+-------+-----------------+
+----------+----------+
| Header 1 | Header 2 |
+==========+==========+
| Cell 1-1 | Cell 2-1 |
+----------+----------+
| Merged Cell 1 |
+---------------------+
<table>
<thead>
<tr>
<th colspan="2">Table Headings</th>
<th>Here</th>
</tr>
<tr>
<th>Sub</th>
<th>Headings</th>
<th>Too</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="2">cell spans rows</td>
<td colspan="2">column spanning</td>
</tr>
<tr>
<td>normal</td>
<td>cell</td>
</tr>
<tr>
<td><p>multi line</p>
<p>cells too</p></td>
<td colspan="2">cells can be <em>formatted</em>
<strong>paragraphs</strong></td>
</tr>
</tbody>
</table><table>
<thead>
<tr>
<th>Header 1</th>
<th>Header 2</th>
</tr>
</thead>
<tr>
<td>Cell 1-1</td>
<td>Cell 2-1</td>
</tr>
<tr>
<td colspan="2">Merged Cell 1</td>
</tr>
</table>
This type of table supports multi-line cells and merged cells (horizontally and vertically). Cell alignment must be manually maintained using spaces. MD text formatting features can be reused inside cells.
Table (Complex) – List-table
:::{.list-table aligns=c,c,c header-rows=2}
* - []{rowspan=2} Merged Column
- []{colspan=2} Merged Row
* - Cell 2-2
- Cell 2-3
* - Cell 3-1
- Cell 3-2
- Cell 3-3
:::
<table>
<thead>
<tr>
<th rowspan="2" style="text-align: center;"> Merged Column</th>
<th colspan="2" style="text-align: center;"> Merged Row</th>
</tr>
<tr>
<th style="text-align: center;">Cell 2-2</th>
<th style="text-align: center;">Cell 2-3</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">Cell 3-1</td>
<td style="text-align: center;">Cell 3-2</td>
<td style="text-align: center;">Cell 3-3</td>
</tr>
</tbody>
</table>
This type of table supports cell merge across rows and columns. It also supports cell attributes and alignments.
Inline HTML
<span class="editors-note">Editor's Note: This is FFS.</span>
<div class="acronyms">
| Acronym | Definition |
|---------|------------|
...
</div>
<span class="editors-note">Editor's Note: This is FFS.</span>
The native support for inline HTML to wrap specific (regular) expressions such as NOTE, Editor’s Note or even list of acronyms can allow standard classes to be defined to apply dedicated CSS when rendering.
A guide to the Latex equation format can be found at https://tug.ctan.org/info/undergradmath/undergradmath.pdf. In the HTML format, either MathML or images in the SVG format can be used to render the equations, and in the PDF format, the image representation is necessary. Additionally, WYSIWYG editors for Latex equations are available as standalone software available offline and as online tools. In either case, an existing equation could be loaded for editing or the tool could be used to create a new equation. The result would then be copied into the Markdown file directly.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.5 3GPP extensions to Markdown with custom processing
| To support elements which are specific to 3GPP, some extensions to Markdown have been prototyped. These extensions are written in a language called Lua (https://www.lua.org/), for which an interpreter is built directly into Pandoc, the tool used to convert from Markdown to HTML. The benefit of using Lua over other languages is that the Lua interpreter built into Pandoc has direct access to the structure of the document, making it easy to iterate over custom blocks such as those used to produce the examples of Table 5.3.1.5-1.
The most straightforward mechanism to perform custom processing in Markdown is to use the code block delimiter with a custom name. Note that in the Markdown version of each feature, the inline code block starts three tildes (~~~) followed by a format name and ends with three tildes (~~~). As part of the command to convert Markdown to HTML, a series of Lua scripts can be entered, with or without parameters, depending on the conversion.
Details on how Lua filters work in Pandoc can be found at https://pandoc.org/lua-filters.html. The basic premise is that the Pandoc iterates over all the elements in a document in its intermediate document representation format, known as the Abstract Syntax Tree (AST). One element which can be found in the AST is the CodeBlock. Lua filters are called on every type of element encountered in the AST, so conditions are used to determine execution.
An example beginning to a Lua function that operates on a CodeBlock is shown below. The function takes a block as input and checks if the type of block is “mscgen”.
function CodeBlock(block)
if block.classes[1] == “mscgen” then
If there is a match, another function is called, which takes the MSC generator source and the chart type as input. The output is the binary representation of the image generated by the tool. The image is given a name, which could come directly from the figure number, and inserted into what Pandoc refers to as its media bag, containing all the images of the document.
pandoc.mediabag.insert(filename, filetype, image)
Then, the caption of the chart is created and attached to the figure.
Lastly, the entire CodeBlock is replaced with a reference to the newly generated image and its name so that when the HTML file is generated, the figure insertion is treated normally as an image insertion.
Table 5.3.1.5-1: 3GPP extensions to Markdown
Feature
Markdown
HTML
Notes
ASN.1 colorization and indentation
~ ~ ~ asn1
DL-CCCH-MessageType ::= CHOICE {
c1 CHOICE {
rrcReject RRCReject,
rrcSetup RRCSetup,
spare2 NULL,
spare1 NULL
},
messageClassExtension SEQUENCE {}
}
~~~
<div class="asn1-indent-0">DL-CCCH-MessageType ::= <span class="asn1-keyword">CHOICE</span> {</div>
<div class="asn1-indent-1">c1 <span class="asn1-keyword">CHOICE</span> {</div>
<div class="asn1-indent-2">rrcReject RRCReject,</div>
<removed>
Only an excerpt of the HTML is shown because it isn’t human-readable.
Indentation is applied with special classes named asn1-indent#, where # is the level.
Keyword colorization is applied with the class named asn1-keyword.
Comment colorization, not shown here, is applied with the class named asn1-comment.
Band combination tables insertion
~~~ json-table
Table 5.5A.2-2: NR CA configurations and bandwidth combination sets defined for mixed intra-band contiguous and non-contiguous CA;
../contributions/bandCombinations/38.101-1;
INTRABAND_MIXED
~~~
HTML table not shown.
The json-table identifier is used for this code block. The first input is the table caption. The second is the path to the band combinations, and the third is a reference to which band combination.
Cover page insertion
The cover page is inserted using a Lua filter which takes the path to an HTML file as input. The HTML file is simply the cover page for the specification.
The cover page is written in HTML because there is more freedom for layout and it is a relatively static page, not benefiting much from auto-generation.
MSC-Generator signalling diagram
~~~ mscgen
{caption="Figure 5.3.2.1-1: Paging"}
hscale=auto;
u: UE;
n: Network;
hspace u - n 200;
n->u: Paging;
~~~
<img src="fig_5.3.2.1-1.svg"/>
The image of the figure is generated using msc-generator and saved as an SVG file as part of the conversion process and then inserted into the HTML using the <img> tag.
Table of contents generation and insertion
The table of contents is inserted using a Lua filter which identifies and tags all headings, extracts their titles, and creates a table of contents in HTML and inserts it between the cover page and the document body.
The CSS stylesheet handles page numbering in the table of contents and in the header of each page.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.6 How to produce a specification using Markdown
| Markdown source is not presentable on its own as it is a language intended to be converted to HTML, using a simple syntax and a subset of the features of HTML. Many tools are available for converting Markdown to HTML, but the one which will be used in this solution is called Pandoc, which can be found at https://pandoc.org/. Pandoc is capable of converting between many formats, but we will focus on the conversion from Markdown to HTML.
Figure 5.3.1.6-1 illustrates the process. The input is the Markdown source file, which has the extension “.md”, and any images and resources, and the output is an HTML file, which has the extension “.html”, and any original images and converted resources.
Figure 5.3.1.6-1: Process to convert from Markdown to HTML using Pandoc
The input includes markdown source, text resources, image resources, and images. Source is considered native to the base version of Markdown or to the chosen extension to Markdown, e.g., GitHub-flavoured Markdown. Text resources are those which are entered directly into the Markdown file or referenced as files from the Markdown file and converted into a different text representation in the HTML. Example text resources include equations and ASN.1 source. Image resources are those which are entered directly into the Markdown file or referenced as files from the Markdown file and converted into images. Images are simply copied into the HTML representation as they are natively supported.
Figure 5.3.1.6-2: Detailed process to convert from Markdown to HTML using Pandoc
Each type of element in the Markdown document, whether native or not, requires a stage which converts the element into intermediate resources which are inserted into the HTML or which converts the element directly into HTML.
Figure 5.3.1.6-3 illustrates one-stage conversion of a simple type, a heading, which is further explained in clause 5.3.1.5. The Markdown formatting is stripped off and HTML formatting is wrapped around the heading title.
Figure 5.3.1.6-3: Conversion of a simple type from Markdown to HTML
The complex types, which typically result in images or custom formatted text, use a two-stage process. In the additional stage, the complex type is inputted to a conversion stage, the output of which is a resource, e.g., an image, and HTML which inserts the resource into the HTML document, e.g., an image tag which points to an image resource. Figure 5.3.1.6-4 shows an example of converting a signalling chart written in MSC Generator and inserting it into the resulting HTML document.
Figure 5.3.1.6-4: Conversion of a complex type, sequence chart, from Markdown to HTML
Another element to discuss is how styles are applied to the HTML document. The most common mechanism by which styles are applied to an HTML file is through the use of cascading stylesheets (CSS), which can be specified inline to the HTML or externally in a CSS file. Stylesheets work similarly to styles in Microsoft Word, except that styles are not individually applied but rather they are applied automatically depending on the type of element.
For example, the following styles were defined for heading text mimicking the current specifications. Note that the first header style has a thin border on the top, “border-top”, a larger font size than the others, 24, and has additional padding on the bottom to make it more prominent. The remaining headers use the default font and only set the size.
h1 {
font-size: 24px;
border-top: 1px solid;
width: 100%;
float:left;
padding-bottom: 3px;
}
h2 { font-size: 21px; }
h3 { font-size: 19px; }
h4 { font-size: 16px; }
h5 { font-size: 15px; }
h6 { font-size: 13px; }
These styles apply a font size to all six heading styles but treats the first heading level specially by including a black line border above the heading and applying more padding below the header than for the others.
The last step to create a publishable specification is to convert the HTML file to a PDF. A program called WeasyPrint (https://weasyprint.org/) is used. WeasyPrint creates converts HTML to a PDF with consideration to the CSS stylesheet provided with the HTML file. In this solution, the “print” view is used to automatically add headers to each page, including the title and page number, and to properly number the table of contents. All internal links are functional in the PDF version.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.7 Handling of bitmap or bit pattern elements in specifications (e.g. MAC, RLC, PDCP)
| The bitmap or bit pattern representations are used in e.g. MAC specification to describe PDU formats and control element structures using figures (created using e.g. Visio). These can be represented either via figures or via textual representations using ASCII text or ASN.1 as exemplified below.
Table 5.3.1.7-1: Example of using ASCII or ASN.1 formats for Short and Long BSR MAC CEs
Representation
Format
Current MAC
ASCII
+----+-----+----+----+----+----+----+----+
| LCG ID | Buffer size |
+----+-----+----+----+----+----+----+----+
+------+------+------+------+------+------+------+------+
| LCG7 | LCG6 | LCG5 | LCG4 | LCG3 | LCG2 | LCG1 | LCG0 |
+------+------+------+------+------+------+------+------+
| Buffer size 1 |
+------+------+------+------+------+------+------+------+
| ... |
+------+------+------+------+------+------+------+------+
| Buffer size m |
+------+------+------+------+------+------+------+------+
ASN.1
BufferStatusReportShort ::= SEQUENCE {
-- LCG:
logicalChannelGroup ID INTEGER (1..maxLCG)),
-- (Quantized) buffer size:
bufferSize INTEGER (0..maxShortBS-ID
}
maxLCG INTEGER ::= 8 -- Maximum number of LCG identities
maxShortBS-ID INTEGER ::= 31 -- Maximum number of short BS IDs
BufferStatusReportLong ::= SEQUENCE ( SIZE (1..maxLCG)) OF BufferStatusLong
BufferStatusLong ::= SEQUENCE {
-- LCG:
logicalChannelGroup ID INTEGER (1..maxLCG)),
-- (Quantized) buffer size:
bufferSize INTEGER (0..maxShortBS-ID
}
maxLCG INTEGER ::= 8 -- Maximum number of LCG identities
maxShortBS-ID INTEGER ::= 255 -- Maximum number of long BS IDs
-- Alternative implementation
BufferStatusReportLong ::= SEQUENCE {
-- (Quantized) buffer size for LCG1:
bufferSize_LCG1 INTEGER (0..maxShortBS-ID) OPTIONAL,
-- (Quantized) buffer size for LCG2:
bufferSize_LCG2 INTEGER (0..maxShortBS-ID) OPTIONAL,
-- (Quantized) buffer size for LCG3:
bufferSize_LCG3 INTEGER (0..maxShortBS-ID) OPTIONAL,
-- (Quantized) buffer size for LCG4:
bufferSize_LCG4 INTEGER (0..maxShortBS-ID) OPTIONAL,
-- (Quantized) buffer size for LCG5:
bufferSize_LCG5 INTEGER (0..maxShortBS-ID) OPTIONAL,
-- (Quantized) buffer size for LCG6:
bufferSize_LCG6 INTEGER (0..maxShortBS-ID) OPTIONAL,
-- (Quantized) buffer size for LCG7:
bufferSize_LCG7 INTEGER (0..maxShortBS-ID) OPTIONAL,
-- (Quantized) buffer size for LCG8:
bufferSize_LCG8 INTEGER (0..maxShortBS-ID) OPTIONAL
}
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.3.1.8 Front Matter
| In Markdown documents, the YAML front matter refers to a block of metadata placed at the very top of a file, typically enclosed between triple dashes (---). This section is widely supported by many Markdown parsers and tools. The front matter allows declaring structured metadata about the document—including titles, versioning, authorship, dates, keywords, and references—using a simple, human-readable syntax (YAML).
The inclusion of a YAML front matter section serves several important purposes:
- Centralised Metadata: It provides a standardised location for essential document information, which can be programmatically accessed and utilised by tools or platforms processing the Markdown files.
- Automated Processing: Depending on the metadata stored, tools can automatically generate e.g. cover sheets, tables of contents, indexes, and cross-references, or manage versioning and release notes, based on the declared metadata.
- Enhanced Interoperability: By adopting a common format for metadata within a TS/TR Markdown file, documents become more portable and easier to integrate into diverse workflows and MCC’s document databases and publishing systems to e.g. create printer-ready PDF.
- Clarity and Transparency: The YAML syntax is readable and straightforward, making it easy for editors and reviewers to verify and update document properties without delving into the content itself.
For 3GPP specifications, adopting YAML front matter for Markdown would offer significant benefits. It would streamline the documentation process by allowing all necessary specification details—such as the TS/TR title, number, version, release, and keywords—to be captured directly within each document. This approach would facilitate automated document management and publication, support traceability of changes, and simplify integration with collaborative authoring platforms. Moreover it can serve as a directory, annexes and change histories can be referenced within the metadata, improving document organisation and accessibility for both contributors and users.
Many Markdown parsers support a front matter section that can be used to convey a manifest for the metadata of a document, notably the TS/TR’s title, version, specification number, etc. list of contents (e.g. referenced images or other Markdown files to be included). 3GPP should then specify the front matter grammar listing all required, recommended and optional metadata, e.g. based on the example in Table 5.3.1.8-1.
Table 5.3.1.8-1: Example YAML front matter for TR 21.801
---
title: "Specification drafting rules"
doc_type: "Technical Report"
doc_number: "21.801"
version: "19.0.0"
release: "Rel-19"
publication_date: "2025-03"
tsg: "Service and System Aspects"
document_classification: "Public"
keywords:
- "GSM"
- "UMTS"
- "LTE"
- "5G"
- "methodology"
annexes:
- title: "Annex C (normative): Drafting and presentation of terms and definitions"
file: "annex/C.md"
change_history:
- date: "2024-03"
meeting: "SA#103"
tdoc: "SP-240277"
cr: "0062"
rev: null
cat: "D"
subject: "Editorial clean-up"
new_version: "18.0.0"
- date: "2025-03"
meeting: "SA#107"
tdoc: "SP-250243"
cr: "0065"
rev: null
cat: "C"
subject: "Update of mathematical formulae and tools used"
new_version: "19.0.0"
---
# HEADING1
...
Many elements in current 3GPP TS/TR documents such as lists of abbreviations, references, change history, etc. are in fact metadata that should rather be stored in a structured manner e.g. in a YAML front matter. Such analysis is TBD.
Depending on the layout of a specification using Markdown, i.e. single-file Markdown vs. multiple Markdown files in a dedicated folder per specification, a dedicated YAML file could be considered, containing all that information, i.e. all content of Table 5.3.1.8-1 enclosed between triple dashes (---). During automated processing the YAML file could be prepended to the Markdown as a front matter as described in this clause above.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.4 Proposal #4: Multiple formats for single specification with Markdown as baseline
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.4.1 Description
| A single specification can be represented or stored in multiple file formats, where each format may contain either specific parts or elements (as shown in the table below) or a complete, self-contained version of the specification (e.g., docx or pdf etc.).
In the table below it is described how the various specification elements of a single specification could be stored, i.e. which file format they could be stored, where the main document of the specification is written with Markdown.
It should be noted that some specification elements can be captured in different formats depending on what is to be captured. One such example is tables, e.g. small tables might best be captured inline with the procedural text and hence captured in Markdown, but very large tables might best be captured in for example JSON.
Table 5.4.1-1: Specification elements of a single specification, files formats and tools.
Specification element
(NOTE 1)
File formats
(NOTE 2)
(NOTE 3)
Tools
Notes
Main document of the specification, including procedural text and similar (formatted text)
Markdown (*.md)
Any text editor such as Notepad++, Visual Studio Code, Vim, Ghostwriter, vscodium, etc.
Tools are mentioned as examples. In principle any text editor could be used to edit markdown files.
Visual Studio Code allows searching over multiple files.
Tables
JSON (*.json) for large tables
Markdown (*.md) within the main document for small tables
Excel (*.xlsx) for tables requiring mathematical calculation.
Any text editor such as Notepad++, Visual Studio Code, Vim, etc
JSON syntax checker/validator
For excel: MS Windows, WPS
All the open-source free tools mentioned here have open-source extensions for Markdown and JSON syntax checking and validation.
Sequence diagrams
Text file (.txt) + PNG or JPEG files
Any text editor + PlantUML or MSC Generator
Any text editor for the textual description of the flow chart. PlantUML or MSC generator for generating the corresponding PNG or JPEG file.
ASN.1
Text file (*.asn)
Any text editor such as Notepad++ or Visual Studio Code + optionally ASN.1 syntax checking extension (e.g. ASN.1 by OSS Nokalva Inc. extension for VSCode)
The ASN.1 elements can be distributed in multiple files which then can be referenced/imported in other ASN.1 files.
Equations
LaTeX written within Markdown for formulas within the main document
Images
Any General-Purpose Diagramming Tool File
Any General-Purpose Diagramming Tools
A PNG or JPEG file should may be generated from the diagram file. The image in the PNG format can be referenced and displayed from the Markdown file. .Where possible a SVG file should be generated, as its file size is smaller. Further, for diagrams that are not generated by other tools, such as arbitrary figures, the preferred file format is SVG as this is editable by a variety of vector graphic tools.
OpenAPI
Text file (.yaml)
YAML text parser (Notepad++) to generate YAML file (note that new swagger version does not support saving of YAML file and cross checking).
OpenAPI YAML syntax checker (Swagger tool)
As done in SA and CT WGs (cf Annex B)
XML Schemas
.xsd (XML Schema Definition)
XML syntax checker/validator.
As done in SA3 and SA5 (cf Annex B)
YANG model
.yang
SA5 YANG data models are validated by an automated pipeline that runs for every push or merge-request event
As done in SA and CT WGs (cf Annex B)
Machine processable files specified in TTCN-3 language
.ttcn
Several TTCN-3 compilers can be used for syntax checking the TTCN-3 files.
As done in RAN5 (cf Annex B)
NOTE 1: Some elements may appear only in some specifications but not in all specifications.
NOTE 2: Depending on the exact way of working with such formats, there may be a requirement that multiple formats shall be able to be converted to a format that can be easily reviewed, searched, etc. by tools that satisfy requirements in clause 4.3 in an efficient manner.
NOTE 3: Conversion from a rich document format to other simpler formats can be problematic – as much of the formatting and other information can be lost when saved as a simpler format. Proper conversion from a rich format to a simpler format, if done, requires direct intervention by authors.
To summarize the proposal, the above is a list of potential ways to keep various specification elements, i.e. in which file formats they should be kept. The format of the files shall be such that is serves the best the characteristics of the specification element, e.g., Markdown for the procedural text, asn-files for ASN.1, etc.
Regarding tools to write these formats, in many cases a simple text editor could be sufficient, however they could also be edited in something like the 3GPP Forge.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.5 Proposal #5: LaTeX
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.5.1 Description
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.5.1.1 Introduction of LaTeX
| LaTeX is high-quality typesetting system, intended for production of technical and scientific documentation [4]. LaTeX has a stable specification and uses widely in academic publications for high-quality literature prints. As the file format and typeset-ting system is intended for technical and scientific documentation, it supports all formatting that Microsoft Word can produce and even more. While LaTeX was not designed to be a WYSIWYG typesetting system, there are tools available that allow users to get “what you see is what you mean” (WYSIWYM) what is often called “near WYSWYG experience”. A short list of such tools is LyX, TeXmacs, Overleaf, Scientific Word, and TeXstudio. As LaTex is a mature file format, there are numerous editors that aid document processing. Comparison of various TeX editors are available in https://en.wikipedia.org/wiki/Comparison_of_TeX_editors.
As LaTeX is targeted for technical documentation, it might be difficult to fully list of formatting and features that it can support. The Latest LaTeX specification is LaTeX2e, which was created in 1994. There was some effort to create a new LaTeX system called LaTeX3. However, this was determined non-feasible to due backwards compatibility issues. Features intended for LaTeX3 has slowly been updated to LaTeX2e. As LaTeX2e will continue to support full backwards compatibility, any new feature additions to the typesetting should not impact future 3GPP specifications if LaTeX is leveraged today.
What may be more challenging for adoption of LaTeX is actually the number of library packages that provide additional functionality to LaTeX. As LaTeX is extremely mature, the number of support libraries are also numerous. Many libraries provide similar functionality. In fact, they are too numerous to a point where MCC may want to limit the usages of libraries for 3GPP specification to make sure a consistent experience for all users working with 3GPP specification.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.5.1.2 Benefits of LaTeX
| The following are some formatting features that are distinct from Microsoft Word which may be of interest for 3GPP specifications.
- Separation of typesetting configuration & actual literature content
- LaTeX is consists of two aspects. Typesetting configuration and literature content. It is possible to separate the two. The default formatting rules for a document could be programmed to follow specific rules needed and can be stored in a separate file with cls extension. These default formatting rules can be determined by MCC, and all users (editors, delegates, etc.) will not need to deal with the default formatting rules.
- Separation of large document into separate files & insertion of multiple files into publication document
- LaTeX allows insertion of technical content that is stored in separate files, but all belong to the same publication. This allows different Clauses that may have large content to be separated into different files and handled separately.
- Re-use of same sub-content file in different specifications
- Since it is possible to store a small part of the specification and insert the files into a publication, it also allows same file to be re-used in different specifications without any duplication. If different 3GPP specification must leverage the same technical content (say a table), it may be possible to use the same source file for multiple specifications and complete avoid any mis-synchronization issues between different specifications.
- Changing page size or orientation of select pages of the specification
- Similar to Microsoft Word, it is possible to change the page size or even change the orientation (either horizontal or vertical orientation) of the text. This supports to fit large tables in a single TS/TR document.
- Integration of math symbols and text
- LaTeX excels in rendering beautifully typed mathematical equations as part of the text.
- Complex tables
- LaTeX allows support for complex tables that have merged cells, vertical texts, etc. However, it should be noted that source code representation for tables is not user friendly. The rendered output representation may look clean and pretty, but the actual source code may look complex.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.5.1.3 Examples of LaTeX drafting
| In this section, some examples of how LaTeX is drafted and rendered is provided. Additionally, comparison with another popular markup language, Markdown, is provided to provide context of LaTeX as a markup language and to show case how LaTeX handles different use cases of 3GPP specification drafting. The example shows the rendering output based on provided example the source. Four 4 different uses cases have been selected as examples.
- Case 1: handling general text (including bullet lists)
- Case 2: handling tables & mathematical equations
- Case 3: handling of ASN.1 code snippets
- Case 4: handling of figures
For LaTeX, some front matter in the beginning of the document is needed to correctly render the text, lists, tables, figures, and code. Once completed, most users should not need to change the front matter and could be potentially handled by MCC.
It should be noted that when converting Markdown directly into PDF using pandoc, pandoc internally converts the Markdown into LaTeX and uses PDFlatex to generate the PDF.
Overall, LaTeX provides excellent control of text, tables, and figures at the expense of some of extra code.
Table 5.5.1.3-1: Use case 1 - handling general text (including bullet list)
Markdown
LaTeX
No Setup Needed:
Source File:
## 4.4.4.2 Point A
Point A serves as a common reference point for resource block grids and is obtained from:
- for a PCell downlink where *offsetToPointA* represents the frequency offset between point A and the lowest subcarrier of the lowest resource block, which overlaps with the SS/PBCH block, or the SS/PBCH block after puncturing if applicable, used by the UE for initial cell selection, expressed in units of resource blocks assuming 15 kHz subcarrier spacing for FR1 and 60 kHz subcarrier spacing for FR2 and FR2-NTN;
- for operation without shared spectrum channel access in FR1, FR2-1 and FR2-NTN, the lowest resource block has the subcarrier spacing provided by the higher layer parameter *subCarrierSpacingCommon*;
- for operation with shared spectrum channel access in FR1 or FR2, and for operation without shared spectrum channel access in FR2-2, the lowest resource block has the subcarrier spacing same as the SS/PBCH block used by the UE for initial cell selection;
- *absoluteFrequencyPointA* for all other cases where *absoluteFrequencyPointA* represents the frequency-location of point A expressed as in ARFCN.
Front Matter for LaTeX document (Setup):
\documentclass{article}
% Packages for formatting
\usepackage{amsmath, amssymb}
\usepackage{geometry}
\geometry{margin=1in}
\renewcommand{\labelitemi}{--} % global dash style
\begin{document}
Source File:
\subsubsection*{4.4.4.2 Point A}
Point A serves as a common reference point for resource block grids and is obtained from:
\begin{itemize}
\item for a PCell downlink where \emph{offsetToPointA} represents the frequency offset between point A and the lowest subcarrier of the lowest resource block, which overlaps with the SS/PBCH block, or the SS/PBCH block after puncturing if applicable, used by the UE for initial cell selection, expressed in units of resource blocks assuming 15 kHz subcarrier spacing for FR1 and 60 kHz subcarrier spacing for FR2 and FR2-NTN;
\item for operation without shared spectrum channel access in FR1, FR2-1 and FR2-NTN, the lowest resource block has the subcarrier spacing provided by the higher layer parameter \emph{subCarrierSpacingCommon};
\item for operation with shared spectrum channel access in FR1 or FR2, and for operation without shared spectrum channel access in FR2-2, the lowest resource block has the subcarrier spacing same as the SS/PBCH block used by the UE for initial cell selection;
\item \emph{absoluteFrequencyPointA} for all other cases where \emph{absoluteFrequencyPointA} represents the frequency-location of point A expressed as in ARFCN.
\end{itemize}
End Matter for LaTeX document:
\end{document}
Rendered output (Pandoc MD to PDF conversion):
Rendered output:
Table 5.5.1.3-2: Use case 2 - handling tables & mathematic equations
Markdown
LaTeX
No Setup Needed:
Source File:
## 4 Frame structure and physical resources
### 4.1 General
Throughout this specification, unless otherwise noted, the size of various fields in the time domain is expressed in time units $T_{c} = 1/\left(\Delta f_{\text{max}} \right)$
where $\Delta f_{\text{max}} = 480 \cdot 10^{3}$ Hz and $N_{f} = 4096$. The constant $\kappa = T_{s}/T_{c} = 64$ where $T_{s} = 1/\left( \Delta f_{\text{ref}} \cdot N_{\text{f,ref}} \right)$, $\Delta f_{\text{ref}} = 15 \cdot 10^{3}\text{Hz}$ and $N_{\text{f,ref}} = 2048$.
Throughout this specification, unless otherwise noted, statements using the term "UE" in clauses 4, 5, 6, or 7 are equally applicable to the IAB-MT part of an IAB-node and the NCR-MT part of an NCR node.
### 4.2 Numerologies
Multiple OFDM numerologies are supported as given by Table 4.2-1 where $\mu$ and the cyclic prefix for a downlink or uplink bandwidth part are obtained from the higher-layer parameters *subcarrierSpacing* and *cyclicPrefix*, respectively.
<div align="center">
Table 4.2-1: Supported transmission numerologies.
| $\mu$ | $\Delta f =2^{\mu}\cdot 15$ [kHz] | Cyclic prefix |
| :---: | :---: | :---: |
| 0 | 15 | Normal |
| 1 | 30 | Normal |
| 2 | 60 | Normal, Extended |
| 3 | 120 | Normal |
| 4 | 240 | Normal |
| 5 | 480 | Normal |
| 6 | 960 | Normal |
</div>
Front Matter for LaTeX document (Setup):
\documentclass{article}
% Packages for formatting
\usepackage{amsmath, amssymb}
\usepackage{caption}
\usepackage{geometry}
\geometry{margin=1in}
\setlength{\parindent}{0pt}
\begin{document}
Source File:
\section*{4 Frame structure and physical resources}
\subsection*{4.1 General}
Throughout this specification, unless otherwise noted, the size of various fields in the time domain is expressed in time units $T_{c} = 1/\left(\Delta f_{\text{max}} \right)$ where $\Delta f_{\text{max}} = 480 \cdot 10^{3}$ Hz and $N_{f} = 4096$. The constant $\kappa = T_{s}/T_{c} = 64$ where $T_{s} = 1/\left( \Delta f_{\text{ref}} \cdot N_{\text{f,ref}} \right)$, $\Delta f_{\text{ref}} = 15 \cdot 10^{3}\text{Hz}$ and $N_{\text{f,ref}} = 2048$.
Throughout this specification, unless otherwise noted, statements using the term "UE" in clauses 4, 5, 6, or 7 are equally applicable to the IAB-MT part of an IAB-node and the NCR-MT part of an NCR node.
\subsection*{4.2 Numerologies}
Multiple OFDM numerologies are supported as given by Table 4.2-1 where $\mu$ and the cyclic prefix for a downlink or uplink bandwidth part are obtained from the higher-layer parameters \emph{subcarrierSpacing} and \emph{cyclicPrefix}, respectively.
\begin{table}[h]
\centering
\caption*{Table 4.2-1: Supported transmission numerologies.}
\begin{tabular}{|c|c|c|}
\hline
$\mu$ & $\Delta f =2^{\mu}\cdot 15$ [kHz] & Cyclic prefix \\
\hline
0 & 15 & Normal \\
1 & 30 & Normal \\
2 & 60 & Normal, Extended \\
3 & 120 & Normal \\
4 & 240 & Normal \\
5 & 480 & Normal \\
6 & 960 & Normal \\
\hline
\end{tabular}
\end{table}
End Matter for LaTeX document:
\end{document}
Rendered output (Pandoc MD to PDF conversion):
Rendered output:
Notes of drafting:
Markdown does not natively support tables and math equations. The source code is pandoc markdown variant method for tables and equations.
Markdown does not natively support centered text. Therefore, html block insertion is needed to center text using <div align=“center”> and </div> commands. It should be noted that pandoc does not seem to parse all the html blocks correctly as the Table caption does not center align properly even if html code.
Table 5.5.1.3-3: Use case 3 - handling ASN.1 code
Markdown
LaTeX
No Setup Needed:
Source File:
### ***– FrequencyInfoDL-SIB***
The IE FrequencyInfoDL-SIB provides basic parameters of a downlink carrier and transmission thereon.
<div align="center">
**FrequencyInfoDL-SIB information element**
</div>
```asn1
-- ASN1START
-- TAG-FREQUENCYINFODL-SIB-START
FrequencyInfoDL-SIB ::= SEQUENCE {
frequencyBandList MultiFrequencyBandListNR-SIB,
offsetToPointA INTEGER (0..2199),
scs-SpecificCarrierList SEQUENCE (SIZE (1..maxSCSs)) OF SCS-SpecificCarrier
}
```
Front Matter for LaTeX document (Setup):
\documentclass{article}
% Packages for formatting
\usepackage{xcolor}
\usepackage{listings}
\usepackage{geometry}
\geometry{margin=1in}
% Color palette
\definecolor{asnKeyword}{HTML}{8B0000} % maroon
\definecolor{asnComment}{HTML}{6A737D} % gray
\definecolor{asnString}{HTML}{032F62} % dark blue
\definecolor{asnBg}{HTML}{F6F8FA} % light gray background
% Style for code blocks
\lstdefinelanguage{ASN1}{
morekeywords={SEQUENCE,CHOICE,INTEGER,SIZE,OF},
sensitive=true,
morecomment=[l]{--}, % ASN.1 line comments
morestring=[b]"
}
\lstdefinestyle{asnStyle}{
language=ASN1,
basicstyle=\ttfamily\small,
keywordstyle=\color{asnKeyword}\bfseries,
commentstyle=\color{asnComment}\itshape,
stringstyle=\color{asnString},
backgroundcolor=\color{asnBg},
numbers=left,
numberstyle=\scriptsize\color{asnComment},
stepnumber=1,
numbersep=10pt,
showstringspaces=false,
tabsize=2,
frame=single,
rulecolor=\color{asnComment},
breaklines=true,
breakatwhitespace=true,
keepspaces=true
}
\begin{document}
Source File:
{\large \textbf{\emph{– FrequencyInfoDL-SIB}}}
The IE FrequencyInfoDL-SIB provides basic parameters of a downlink carrier and transmission thereon.
\begin{center}
\textbf{FrequencyInfoDL-SIB information element}
\end{center}
\begin{lstlisting}[style=asnStyle, language=ASN1]
-- ASN1START
-- TAG-FREQUENCYINFODL-SIB-START
FrequencyInfoDL-SIB ::= SEQUENCE {
frequencyBandList MultiFrequencyBandListNR-SIB,
offsetToPointA INTEGER (0..2199),
scs-SpecificCarrierList SEQUENCE (SIZE (1..maxSCSs)) OF SCS-SpecificCarrier
}
\end{lstlisting}
End Matter for LaTeX document:
\end{document}
Rendered output (Pandoc MD to PDF conversion):
Rendered output:
Notes of drafting:
Markdown does not natively support ASN.1 code highlighting. The ASN.1 code highlights for Pandoc based Markdown rendering are enabled by Haskell library called “skylighting” (https://github.com/jgm/skylighting) and any changes to this library will result in different render output for Pandoc. For different Markdown variants, the code highlighting is enabled by different libraries and could result in different output.
Table 5.5.1.3-4: Use case 4 - handling of figures
Markdown
LaTeX
No Setup Needed:
Source File:
## 4.3.1 Frames and subframes
Downlink, uplink, and sidelink transmissions are organized into frames with $T_{f} = \left( \Delta f_{\text{max}} N_f / 100 \right) \cdot T_c$ ms duration, each consisting of ten subframes of $T_{sf} = \left( \Delta f_{\text{max}} N_f / 10000 \right) \cdot T_c = 1$ ms duration. The number of consecutive OFDM symbols per subframe is $N_{\text{symb}}^{\text{subframe},\mu} = N_{\text{symb}}^{\text{slot}}
N_{\text{slot}}^{\text{subframe},\mu}$. Each frame is divided into two equally-sized half-frames of five subframes each with half-frame 0 consisting of subframes 0 - 4 and half-frame 1 consisting of subframes 5 - 9.
<div align="center">
**Figure 4.3.1-1 Uplink-downlink timing relation**
</div>
Front Matter for LaTeX document (Setup):
\documentclass{article}
% Packages for formatting
\usepackage{amsmath, amssymb}
\usepackage{caption}
\usepackage{graphicx}
\usepackage{geometry}
\geometry{margin=1in}
\begin{document}
Source File:
\subsubsection*{4.3.1 Frames and subframes}
Downlink, uplink, and sidelink transmissions are organized into frames with $T_{f} = \left( \Delta f_{\text{max}} N_f / 100 \right) \cdot T_c$ ms duration, each consisting of ten subframes of $T_{sf} = \left( \Delta f_{\text{max}} N_f / 10000 \right) \cdot T_c = 1$ ms duration. The number of consecutive OFDM symbols per subframe is
$N_{\text{symb}}^{\text{subframe},\mu} = N_{\text{symb}}^{\text{slot}}
N_{\text{slot}}^{\text{subframe},\mu}$. Each frame is divided into two equally-sized half-frames of five subframes each with half-frame 0 consisting of subframes 0 -- 4 and half-frame 1 consisting of subframes 5 -- 9.
\begin{figure}[h]
\centering
\includegraphics[width=0.5\textwidth]{media/figure4-3-1-1.png}
\caption*{Uplink-downlink timing relation}
\end{figure}
End Matter for LaTeX document:
\end{document}
Rendered output (Pandoc MD to PDF conversion):
Rendered output:
Notes of drafting:
Markdown does not natively support scaling of the image being inserted. For advanced image scaling, html block codes need to be leveraged.
Image file formats supported by Markdown depends on Markdown variant. In case of Pandoc Markdown, PNG, JPEG/JPG, GIF, and SVG are supported.
Notes of drafting:
LaTeX does not support any image format. The supported image formats are EPS, PDF, PNG, JPEG/JPG, and JBIG2.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.5.1.4 Example implementation of LaTeX based Specification on 3GPP Forge
| As part of the Specification modernation study, three example LaTeX implementation of RAN specification was created in 3GPP Forge. The example LaTeX implementations are:
- TS38.201 V19.0.0 in https://forge.3gpp.org/rep/fs_6gspecs_new/interdigital_latex_38201.
- TS38.202 V19.0.0 in https://forge.3gpp.org/rep/fs_6gspecs_new/interdigital_latex_38202.
- Parts of TS38.331 V18.6.0 in https://forge.3gpp.org/rep/fs_6gspecs_new/interdigital_latex_38331.
In the example LaTeX, the complex packaging and macro configurations to create specific formatting of text was defined as a LaTeX package called “3gpp.sty”. The 3gpp.sty package contains the macro commands for insertion of copyright notice, trademark information, table of contents, disclaimer information, title information, header/footer, etc. It is meant to separate out formatting from technical content of the specification. Image files are stored in PNG file format under the ‘media’ folder. ‘scripts’ folder contains Perl scripts that could be useful for viewing the changes in PDF. It should be noted that the Perl scripts are not essential to compile the LaTeX specification file to PDF.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.6 Proposal #6: DOCX with restrictions
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.6.1 Description
| This proposal focuses on what can be done to make DOCX and use of MS Word compliant with the requirements.
DOCX format needs no introduction, and so we will omit the description of the format itself for brevity.
To address requirement 4 "Cross Platform", тthe following restrictions shall be introduced and enforced to make DOCX cross platform:
- No OLE-embedded objects
- All figures included as images
- This probably requires that the “source” for the figures (e.g. plantUML, Mermaid, MSC) is stored separately.
- Non-crossplatform sources (e.g. Visio) shall not be allowed
- The workflow possibly Whether this requires tools to automatically generate images from the source and insert into DOCX.
NОТЕ 1: it is not clear whether such tools can be developed for platforms other than Microsoft Windows.
To address requirement 8 "Fast opening, navigating and editing тthe following restrictions are considered and enforced to facilitate fast loading and editing:
- Figure sizes limits
- Limiting number of fonts and styles used, including potential reduction of number of styles for specification drafting
- Limit the fonts and styles to 3gpp defined ones only
- Exhaustive analysis of docx files against 21.801 (cf solution 10).
- Publish specifications without Header and page numbers. Information contained in the Header (Release, 3GPP TS/TR number, version (year-month)) may be moved to the Footer or included only on the first page. (cf solution 31).
- Attach a PDF version of each specification within the zip file of the specification written in Word (cf solution 27).
NОТЕ 2: it is not clear whether and how it would be possible to enforce some of these restrictions.
To address requirement 130 "Tracking of Editor's Notes":
- Include WI and meeting number with editor’s notes - For example, Editor’s Note: [FS_AIML-air_core, RAN2#129] (cf solution 30).
To address requirement 16 "Specification browsing":
- Attach a PDF version of each specification within the zip file of the specification written in Word (cf solution 27).
To address requirement 32 "CR Cover pages":
- Use 3GU CR cover sheet auto-generation function and use the template produced by 3GU (cf solution 5).
To address requirement 15 "Automation", proper use of requirement 21 "Supported styles", requirement 29 "Supported style functions", requirement 39 "Simplicity to follow drafting rules":
- Check the CR styles against 21.801 (cf solution 10).
To address requirement 10 "CR Traceability", requirement 12 "Cross-referencing and hyperlinking", requirement 14 "References to discussion papers" and requirement 26 "Public access to specifications and CRs":
- Include the specification number and clause number in references – When available, include enough information to find the information referenced (cf solution 14).
Additionally,
- Check for updated, changed or newly created styles by using the format inspector (this is tedious and time consuming)
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.6.2 Evaluation against requirements of section 4.3
| Due to similarities and substantial overlap of the "Proposal #6: DOCX with restriction" and "Proposal #7: Multiple formats for single specification with Word as baseline", and considering that these proposals are not mutually exclusive, these proposals are evaluated together. For details see clause 5.7.2.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.7 Proposal #7: Multiple formats for single specification with Word as baseline
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.7.1 Description
| In the table below it is described how the various specification elements of a single specification could be stored, i.e. which file format they could be stored, where the main document of the specification is written with Word.
It should be noted that some specification elements can be captured in different formats depending on what is to be captured. One such example is tables, e.g. small tables might best be captured inline with the procedural text and hence captured in Word, but very large tables might best be captured in for example JSON.
Table 5.7.1-1: Specification elements of a single specification, files formats and tools.
Specification element
(NOTE 1,2)
File formats
Tools
Notes
Main document of the specification, including procedural text and similar (formatted text)
Word (*.docx), with restrictions as in Proposal #6 (see clause 5.6)
MS Word, WPS
Tools are mentioned as examples.
Tables
JSON (*.json) for large tables
Small tables within the main Word document
Excel (*.xlsx) for tables requiring mathematical calculation.
Any text editor such as Notepad++, Visual Studio Code, Vim, etc
JSON syntax checker/validator
For excel: MS Windows, WPS
Open-source free tools that have open-source extensions for JSON syntax checking and validation are preferred.
Diagrams (sequence diagrams, block diagrams, etc.)Sequence diagrams
Text source file (.puml, .msc, .mmd) + generated SVG.Text source file (.txt, or .puml, etc) + generated PNG,JPEG or SVG.
Any text editor + PlantUML or MSC Generator or Mermaid
Any text editor for the textual description of the flow chart. PlantUML or MSC generator for generating the corresponding PNG or JPEG file.
Graphics
SVG + source file
Vector drawing tools such as draw.io, Illustrator or other WYISWYG tools such as Powerpoint to create the graphics. Vector graphics editors such as Illustrator or Inkscape to edit the SVG.
Superset of diagrams; diagrams should be preferred over graphics
Images
PNG, SVG
According to solution 19 (Table 4.2-2): Only cross platform tools. The study may recommend one or more such tools among MSC-gen, plantUML, Mermaid, and Microsoft Word built-in drawing tools.
Use of Visio should be discontinued entirely.
Editors should be encouraged to use plantUML, MSC, or Mermaid where appropriate and only resort to images without editable source if there is no other option.Any image editor.
Solution 17 was also listed in Table 4.2-2: Store figure source files - For editable figures, store at least the source file, named in accordance with the figure number, alongside the specification.It is preferable to produce and store image content using SVG rather than PNG or JPEG files as they are editable and significantly smaller.
150dpi a good rule of thumb for standard images that are not graphics. Graphics should be preferred over images.
ASN.1
Text file (*.asn)
Normative comments may be included (e.g. -- [normative] this is a normative comment --). Normative comments may be used to convey field descriptions instead of tables (tables are used today for field descriptions in RRC specs)
Any text editor such as Notepad++ or Visual Studio Code + optionally ASN.1 syntax checking extension (e.g. ASN.1 by OSS Nokalva Inc. extension for VSCode).
The ASN.1 elements can be distributed in multiple files which then can be referenced/imported in other ASN.1 files.
This is for the case where ASN.1 with normative comments and field description is not directly written in the main Word document (i.e. no need for a tool that could extract the ASN.1 from a Word file).
ASN.1 with normative comments and field description tables (such as used in RRC specification)
A text-based format such as Markdown (*.md) or Asciidoc (*.adoc) or LaTeX (*.tex), to produce IE descriptions like in 5G RRC specification..
Any text editor such as Notepad++, Visual Studio Code, Vim, etc.
This is for the case where ASN.1 with normative comments and field description tables is not directly written in the main Word document (i.e. no need for a tool that could extract the ASN.1 from a Word file). A script is needed to extract the ASN.1 from the Markdown or AsciiDoc or LaTeX document, which should be easier than extracting from Word.
Use of Git is a separate consideration to be further discussed: e.g. editing within Git, using Gitlab for ASN.1 review (i.e. for drafting work)
Equations
Within the main Word document (.docx) as ONML
Word built-in equation editor, textmath for converting mathematical formulas to Office Math Markup Language (OMML)
Legacy OLE-based equations (Microsoft Equation and MathType) to be converted to OMML.
OpenAPI
Text file (.yaml)
YAML text parser (Notepad++) to generate YAML file (note that new swagger version does not support saving of YAML file and cross checking).
OpenAPI YAML syntax checker (Swagger tool)
As done in SA and CT WGs (cf Annex B)
XML Schemas
.xsd (XML Schema Definition)
XML syntax checker/validator.
As done in SA3 and SA5 (cf Annex B)
YANG model
.yang
SA5 YANG data models are validated by an automated pipeline that runs for every push or merge-request event
As done in SA and CT WGs (cf Annex B)
Machine processable files specified in TTCN-3 language
.ttcn
Several TTCN-3 compilers can be used for syntax checking the TTCN-3 files.
As done in RAN5 (cf Annex B)
SDL diagrams in SDT binary files
.ini
.ini file supplied on the 3GPP server
cf TR21.801 Annex I
NOTE 1: some elements may appear only in some specifications but not in all specifications.
NOTE 2: to the extent possible, redundancy shall be discouraged, e.g. if ASN.1 is stored in a separate file, the same content shall not be duplicated in the .DOCX document.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.8 Proposal #8: Standalone ASN.1
| |
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.8.1 Description
| ASN.1 is the language used to define signalling in the radio resource control (RRC) protocol. The language supports many built-in datatypes, e.g., bit strings, Booleans, enumerations, integers, and octet strings, and data structures, e.g., choices and sequences. Every IE is named, and every field within an IE is named such that they can be addressed and described in the procedural descriptions and in field descriptions.
In 5G, ASN.1 is written directly into the docx-file carrying the RRC specification. The protocol definitions are typed or inserted directly into the docx specification and colour-coding and indentation is applied manually or by a macro, e.g., purple for keywords, grey for comments, and black for everything else. Field descriptions and conditional presence tables are placed in tables beneath their applicable IEs after the end of the ASN1 block, containing the fields being described and on which fields there are conditions. Figure 5.8.1-1 shows an excerpt from TS38.331 including RRCReestablishment-v1700-IEs, a field description for sl-L1RemoteUE-Config, and a conditional presence definition, L2RemoteUE, describing that the field is “mandatory present for L2 U2N Remote UE”, and otherwise absent.
Editor’s Note: RAN2 discovered that way how conditions are captured in the NR RRC specification makes it difficult to automate their implementation and verification. RAN2 investigates means to embed conditions/constraints into the ASN.1 syntax. The discussion on conditions in the remainder of this section may therefore not be fully applicable depending on the outcome of RAN2’s 6G study.
Figure 5.8.1-1: ASN.1, Field Description and Conditional Presence in TS38.331
All of these elements can be captured in a native ASN.1 filetype. The only text which is not interpreted by the ASN.1 compiler is text preceded by at least two “-” characters. To minimize extra tooling or custom coding, the easiest way to store the field descriptions and conditional presence definitions would be to use ASN.1 comments. The following sections describe two options each for writing field descriptions and conditional presence definitions. The example of Figure 5.8.1-1 will be used throughout the remainder of this proposal.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.8.1.1 Field descriptions
| The specifications only use comments to delineate blocks of ASN.1, e.g., -- TAG-RRCREESTABLISHMENT-START/STOP and ASN1-START/STOP, and to assign need codes, e.g., -- Need R, and conditional presence, e.g., -- Cond L2RemoteUE, to fields. Therefore, it is feasible to write field descriptions in the line immediately preceding the field being defined. An example is shown in Figure 5.8.1.1-1. Field description examples are shown in blue as an example of how to differentiate field descriptions from other types of comments.
RRCReestablishment-v1700-IEs ::= SEQUENCE {
-- Contains dedicated configurations used for L2 U2N relay related operation. The network configures only the SRAP configuration for local UE ID.
sl-L2RemoteUE-Config-r17 SetupRelease {SL-L2RemoteUE-Config-r17} OPTIONAL, -- Cond L2RemoteUE
nonCriticalExtension SEQUENCE {} OPTIONAL
}
Figure 5.8.1.1-1: Inline field descriptions
If necessary for clarity, a tag could be added in front of each field description. One option would be to introduce a generic tag such as “[field]” or to name the field in the comment as in “-- [sl-L2RemoteUE-Config-r17]” followed by the field description. These options are illustrated in Figure 5.8.1.1-2 and Figure 5.8.1.1-3 below.
RRCReestablishment-v1700-IEs ::= SEQUENCE {
-- [field] Contains dedicated configurations used for L2 U2N relay related operation. The network configures only the SRAP configuration for local UE ID.
sl-L2RemoteUE-Config-r17 SetupRelease {SL-L2RemoteUE-Config-r17} OPTIONAL, -- Cond L2RemoteUE
nonCriticalExtension SEQUENCE {} OPTIONAL
}
Figure 5.8.1.1-2: Inline field descriptions with generic tag
RRCReestablishment-v1700-IEs ::= SEQUENCE {
-- [sl-L2RemoteUE-Config-r17] Contains dedicated configurations used for L2 U2N relay related operation. The network configures only the SRAP configuration for local UE ID.
sl-L2RemoteUE-Config-r17 SetupRelease {SL-L2RemoteUE-Config-r17} OPTIONAL, -- Cond L2RemoteUE
nonCriticalExtension SEQUENCE {} OPTIONAL
}
Figure 5.8.1.1-3: Inline field descriptions with fieldname tag
In 5G, a single field description could be reused for release extension fields such as extensions to reportQuantity in CSI-ReportQuantity, suffixed with “-r16”, “-r17”, and “-r18”. With inline field descriptions, the distance between an original field and extensions to the field would require the redefinition or an understanding that the reader should search for the first instance of a particular base fieldname when looking for a definition.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.8.1.2 Conditional presence definitions
| Conditional presence definitions could be defined inline to the ASN.1, but not inside of the IE definitions since the conditional presence can apply to multiple ASN.1 IEs. To differentiate conditional presence definitions from other types of comments, a simple syntax like that described in section 5.8.1.1 could be used. The syntax to apply a conditional presence to a field would remain the same as today. Figure 5.8.1.2-1 demonstrates the syntax. An example conditional presence description is shown in blue as an example of how to differentiate field descriptions from other types of comments. The conditional presence description uses the following syntax: “-- [cond] <conditional presence name>: <conditional presence description>”, where “--" starts an ASN.1 comment, [cond] indicates that the comment is a conditional presence description.
-- ASN1START
-- TAG-RRCREESTABLISHMENT-START
<omitted>
-- [cond] L2RemoteUE: The field is mandatory present for L2 U2N Remote UE; otherwise it is absent.
RRCReestablishment-v1700-IEs ::= SEQUENCE {
sl-L2RemoteUE-Config-r17 SetupRelease {SL-L2RemoteUE-Config-r17} OPTIONAL, -- Cond L2RemoteUE
nonCriticalExtension SEQUENCE {} OPTIONAL
}
-- TAG-RRCREESTABLISHMENT-STOP
-- ASN1STOP
Figure 5.8.1.2-1: Inline conditional presence definitions
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.8.1.3 Rendering the ASN.1
| The audience of 3GPP specifications is broad, including mobile network operators (MNO), UE vendors, UE chipset vendors, NW vendors, governmental bodies, researchers, delegates, standards defining organizations (SDO), and the interested public. Therefore, it is reasonable to produce a professionally rendered specification including even the ASN.1 with syntax formatting and indentation for the ASN.1 source, and a human-friendly way to read field descriptions and conditional presence definitions.
Through scripting, the field definitions and conditional presence definitions can be recognized and formatted in a way that is useful to the reader. An implementation of comment-based field descriptions and conditional presence definitions described in sections 5.8.1.1 and 5.8.1.2 is shown in Figure 5.8.1.3-1.
An alternative would be to render the field descriptions and conditional presence definitions as tables as they are presented in the specification today (Figure 5.8.1-1).
Figure 5.8.1.3-1: Combination of inline field descriptions and inline conditional presence
Because conditional presence descriptions and field descriptions are written on their own lines, there is no conflict or ambiguity between these and other types of comments.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.8.1.4 Editing the ASN.1
| Integrated development environments (IDEs), which are essentially text editors that at least support syntax highlighting and indentation and commonly support integration with Git and source code syntax checkers and compilers, can be useful in displaying source files such as ASN.1 files in a more human-friendly way. An example of an ASN1 source file opened with Microsoft Visual Studio Code is shown in Figure 5.8.1.4-1.
The Visual Studio Code IDE automatically applies colours to different type of elements such as comments in green, information element (IE) names in orange, datatypes in blue, and the OPTIONAL keyword in purple. The comments are easily distinguished from other text. This example does not differentiate between the existing ASN.1 comments and those for conditional presence and field descriptions because Visual Studio Code treats all comments the same way.
Figure 5.8.1.4-1: ASN.1 source file opened in Visual Studio Code
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 5.8.1.5 Storing the ASN.1
| RAN4 stores their band combination tables in the JSON file format in the 3GPP Forge, and SA5 store YAML files in the 3GPP Forge (https://forge.3gpp.org/rep/sa5/CH/-/tree/Rel-19/OpenAPI). Similarly, it would be feasible to store ASN.1 in asn files in the 3GPP Forge.
Further, we can draw from the example of TS 32.291, a specification under the responsibility of SA5. Figure 5.8.1.5-1 below shows an example of an archive containing a docx file with the specification and two YAML files containing protocol definitions.
5.X Proposal #X
5.X.1 Description
5.X.2 Evaluation against requirements of section 4.3
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 6 Proposals for Tools and Ways of Working
| Editor's note: corresponds to objective 3.
|
5c416a273356c09854424ee0fcfb397b | 21.802 | 6.1 Proposal #1: tools and ways of working for OpenDocument
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.