blob: 6236ab235d44db10aedbb6abce677460377fbcf9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
-*- mode: org -*-
#+TITLE: Doc Reform ≅ (doc-reform) hub, spine
#+DESCRIPTION: documents - structuring, various output representations & search
#+FILETAGS: :spine:hub:
#+AUTHOR: Ralph Amissah
#+EMAIL: [[mailto:ralph.amissah@gmail.com][ralph.amissah@gmail.com]]
#+COPYRIGHT: Copyright (C) 2015 - 2024 Ralph Amissah
#+LANGUAGE: en
#+STARTUP: content hideblocks hidestars noindent entitiespretty
#+PROPERTY: header-args :exports code
#+PROPERTY: header-args+ :noweb yes
#+PROPERTY: header-args+ :results no
#+PROPERTY: header-args+ :cache no
#+PROPERTY: header-args+ :padline no
#+OPTIONS: H:3 num:nil toc:t \n:t ::t |:t ^:nil -:t f:t *:t
- [[./doc-reform.org][doc-reform.org]] [[./][org/]]
- [[./spine_build_scaffold.org][make/build]] VERSION
* spine (sisu document parser) :spine:
** org dir
- directory listing from ./org where program is developed in emacs org-mode
#+NAME: listdir
#+HEADER: :results output replace
#+HEADER: :wrap src text
#+BEGIN_SRC sh
ls -1 *\.org
#+END_SRC
#+RESULTS: listdir
#+begin_src text
compile_time_info.org
config_d_cfte.org
config_dub.org
config_git.org
config_make.org
config_meson.org
config_misc.org
config_nix.org
default_imports.org
default_misc.org
default_paths.org
default_regex.org
default_shared.org
doc-reform.org
in_source_files.org
meta_conf_make_meta.org
meta_debugs.org
ocda.org
out_curate_metadata.org
out_latex.org
out_metadata.org
out_odt.org
output_hub.org
output_show.org
out_sqlite.org
out_src_pod.org
out_xmls_css.org
out_xmls.org
out_zip.org
spine_info.org
spine_markup_sample.org
spine.org
util_spine_markup_conversion_from_sisu.org
util_spine_syntax_highlighting_emacs.org
util_spine_syntax_highlighting_vim.org
#+end_src
** spine
*** spine.org :spine:
- program entry point, takes in command line request and decides how to process
- input files are sent to ocda (object-centric data abstraction) for processing
- output files are sent to the output hub and the requested outputs called
#+NAME: listdir_spine
#+HEADER: :results output replace
#+HEADER: :wrap src text
#+BEGIN_SRC sh
ls -1 spine\.org
#+END_SRC
#+RESULTS: listdir_spine
#+begin_src text
spine.org
#+end_src
*** spine.org calls
**** 0. shared defaults
- regular expressions
- directory paths
misc and shared look at
#+NAME: listdir_default
#+HEADER: :results output replace
#+HEADER: :wrap src text
#+BEGIN_SRC sh
ls -1 default_*\.org
#+END_SRC
#+RESULTS: listdir_default
#+begin_src text
default_imports.org
default_misc.org
default_paths.org
default_regex.org
default_shared.org
#+end_src
**** 1. input file
- rg "\.readText"
#+NAME: listdir_in
#+HEADER: :results output replace
#+HEADER: :wrap src text
#+BEGIN_SRC sh
ls -1 in_*\.org
#+END_SRC
#+RESULTS: listdir_in
#+begin_src text
in_source_files.org
#+end_src
**** 2. meta - intermediate processing
- create the internal document representation for downstream processing
#+NAME: listdir_meta
#+HEADER: :results output replace
#+HEADER: :wrap src text
#+BEGIN_SRC sh
ls -1 ocda\.org meta_*\.org
#+END_SRC
#+RESULTS: listdir_meta
#+begin_src text
meta_conf_make_meta.org
meta_debugs.org
ocda.org
#+end_src
**** 3. outputs
#+NAME: listdir_out
#+HEADER: :results output replace
#+HEADER: :wrap src text
#+BEGIN_SRC sh
ls -1 output_*\.org out_*\.org
#+END_SRC
#+RESULTS: listdir_out
#+begin_src text
out_curate_metadata.org
out_latex.org
out_metadata.org
out_odt.org
output_hub.org
output_show.org
out_sqlite.org
out_src_pod.org
out_xmls_css.org
out_xmls.org
out_zip.org
#+end_src
** misc
*** spine misc
#+NAME: listdir_spine_misc
#+HEADER: :results output replace
#+HEADER: :wrap src text
#+BEGIN_SRC sh
ls -1 spine_*\.org
#+END_SRC
#+RESULTS: listdir_spine_misc
#+begin_src text
spine_info.org
spine_markup_sample.org
#+end_src
*** config
- configure various things related to the project and its build
#+NAME: listdir_config
#+HEADER: :results output replace
#+HEADER: :wrap src text
#+BEGIN_SRC sh
ls -1 config_*\.org
#+END_SRC
#+RESULTS: listdir_config
#+begin_src text
config_d_cfte.org
config_dub.org
config_git.org
config_make.org
config_meson.org
config_misc.org
config_nix.org
#+end_src
*** utils
#+NAME: listdir_util
#+HEADER: :results output replace
#+HEADER: :wrap src text
#+BEGIN_SRC sh
ls -1 util_*\.org
#+END_SRC
#+RESULTS: listdir_util
#+begin_src text
util_cgi_rb_fcgi_sqlite_search.org
util_spine_markup_conversion_from_sisu.org
util_spine_syntax_highlighting_emacs.org
util_spine_syntax_highlighting_vim.org
#+end_src
|
