[v0.1] Refactor tables and FAQs

Author: devpraton

spec/section_descriptions.tex

@@ -18,8 +18,8 @@ \subsection{[ucf-meta]}
 
 \begin{specsubtable}{Key}{Type}{Required}{Description}
   \specsubtablerow{version}{string}{yes}{UCF specification version (e.g., "0.2")}
-  \specsubtablerow{generated-at}{datetime (RFC 3339)}{yes}{UTC or local datetime of file creation}
-  \specsubtablerow{source-app}{string}{yes}{Name or identifier of the application that generated this file}
+  \specsubtablerow{generated-at}{datetime}{yes}{UTC or local datetime of file creation}
+  \specsubtablerow{source-app}{string}{yes}{Identifier of the application that generated this file}
 \end{specsubtable}
 
 Example:
@@ -52,6 +52,8 @@ \subsection{[complainant-details]}
 auth-id = "citizen_02349"
 \end{lstlisting}
 
+\specnote{Sensitive complainant details would be encrypted. This is just for readability sake.}
+
 \subsection{[complaint-details]}
 
 Core description of the issue and the department responsible.

spec/spec.cls

@@ -224,11 +224,11 @@
   \vspace{0.02\textheight} %
 
   % Define table column widths and alignments (L, R or C for left, right or center alignment)
-  \begin{longtable}[H]{@{} L{0.25\textwidth} L{0.65\textwidth}}%
-    \toprule
+  \begin{longtable}[H]{@{} | C{0.25\textwidth} | L{0.65\textwidth} |}%
+    \hline
     % Header row
     \textbf{#1} & \textbf{#2} \\
-    \midrule
+    \hline
   }{
   \end{longtable}
 
@@ -242,7 +242,7 @@
 % Arguments: 1) description 2) quantity 3) unit price 4) note
 \newcommand{\spectablerow}[2]{%
   #1 & #2 \\
-  \midrule
+  \hline
 }
 
 %----------------------------------------------------------------------------------------
@@ -254,11 +254,11 @@
   \vspace{0.02\textheight} %
 
   % Define table column widths and alignments (L, R or C for left, right or center alignment)
-  \begin{longtable}[H]{@{} L{0.15\textwidth} L{0.10\textwidth}  L{0.10\textwidth}  L{0.50\textwidth}}%
-    \toprule
+  \begin{longtable}[H]{@{} | C{0.15\textwidth} | C{0.10\textwidth} | C{0.10\textwidth} | L{0.50\textwidth} |}%
+    \hline
     % Header row
     \textbf{#1} & \textbf{#2} & \textbf{#3} & \textbf{#4} \\
-    \midrule
+    \hline
   }{
   \end{longtable}
 
@@ -272,7 +272,7 @@
 % Arguments: 1) col-1 2) col-2 3) col-3 4) col-4
 \newcommand{\specsubtablerow}[4]{%
   #1 & #2 & #3 & #4\\
-  \midrule
+  \hline
 }
 
 %----------------------------------------------------------------------------------------
@@ -338,7 +338,7 @@
   \expandafter\ifstrequal\expandafter{#2}{}{}{{\large #2}}
 
   % Vertical whitespace
-  \vspace{0.025\textheight}
+  \vspace{0.015\textheight}
 }
 
 %----------------------------------------------------------------------------------------

spec/spec.tex

@@ -7,7 +7,7 @@
 \bigskip
 \hrule
 
-\spectitle{Universal Complaint Format Specification}{VERSION: v0.1}
+\spectitle{Universal Complaint Format Specification}{VERSION: v0.1 | Author: Prathu Baronia}
 
 \section{Overview}
 
@@ -39,38 +39,39 @@ \section{Compliance}
 \end{itemize}
 
 \section{FAQs}
-\begin{specpara}{Why TOML?}
 
+\begin{specpara}{Why TOML?}
 \href{https://toml.io/en}{TOML} is human-readable, simple, and supported across many
 programming \href{https://github.com/toml-lang/toml/wiki}{languages}. Its 
 well-defined syntax ensures minimal ambiguity, making UCF files easy to parse, 
 validate, and generate.
-
 \end{specpara}
 
-\section{Notes}
-\begin{specitemize}{Features}
-
-  \item Autopopulation:  Apps can automatically fill fields
-like `name`, `contact`, `location`, and `auth-id` from user profiles and device
-metadata.
+\begin{specpara}{Which fields will be autopopulated?}
+Fields like `name`, `contact`, `location`, and `auth-id` from user profiles and
+device metadata.
+\end{specpara}
 
-  \item Hashing / Blockchain:  A hash (e.g., SHA256 of the entire `.ucf` file)
-can be embedded or stored separately in on-chain complaint registries for
-verification.
+\begin{specpara}{How blockchain helps here?}
+A hash (e.g., SHA256 of the entire `.ucf` file) can be embedded or stored
+separately in on-chain complaint registries for verification.
+\end{specpara}
 
-  \item Extensibility:  Departments can introduce new optional tables
+\begin{specpara}{Is it extensible?}
+Departments can introduce new optional tables
 (e.g., `[complaint-meta]`, `[response-records]`) without breaking
 compatibility.
+\end{specpara}
 
-  \item Interoperability:  Because TOML is widely supported, implementations in
-various languages (Python, Go, Rust, Node.js, etc.) can easily parse or
-generate `.ucf` files.
-
-  \item Privacy Considerations:  Sensitive citizen information (e.g., contact
-numbers, precise coordinates) should be encrypted or excluded from public
-blockchain entries.
+\begin{specpara}{Is it interoperable?}
+Because TOML is widely supported, implementations in various languages (Python,
+Go, Rust, Node.js, etc.) can easily parse or generate `.ucf` files. So
+multiple system implementations can work easily with the same format.
+\end{specpara}
 
-\end{specitemize}
+\begin{specpara}{Is privacy a concern here?}
+Sensitive citizen information (e.g., name, contact numbers) would be encrypted.
+The plain text citizen info shown above is just for ease of readability.
+\end{specpara}
 
 \end{document}

spec/structure.tex

@@ -3,7 +3,5 @@ \section{General structure}
 
 A \textit{.ucf} file is a valid TOML document in `UTF-8` encoding, containing
 multiple table sections. Each section describes a logical part of the
-complaint.
-
-Each complaint corresponds to one \textit{.ucf} file. Comments begin with \#
-and may appear anywhere outside strings.
+complaint.Each complaint corresponds to one \textit{.ucf} file. Comments begin
+with \# and may appear anywhere outside strings.