aboutsummaryrefslogtreecommitdiffhomepage
path: root/org/spine_info.org
diff options
context:
space:
mode:
Diffstat (limited to 'org/spine_info.org')
-rw-r--r--org/spine_info.org98
1 files changed, 66 insertions, 32 deletions
diff --git a/org/spine_info.org b/org/spine_info.org
index 769b31e..9756354 100644
--- a/org/spine_info.org
+++ b/org/spine_info.org
@@ -20,74 +20,82 @@
* README :readme:
** tangle
-*** org
-**** org text
+*** org contents
+**** org contents tangle
#+HEADER: :tangle "../README"
#+HEADER: :noweb yes
#+BEGIN_SRC text
-<<sisudoc_spine_readme_org_header_org>>
+<<sisudoc_spine_README_header_org>>
-<<sisudoc_spine_readme_project_header_info>>
+<<sisudoc_spine_README_project_header_info>>
,* Summary
-<<sisudoc_spine_readme_summary>>
+<<sisudoc_spine_README_summary>>
+
+,* sisudoc-spine pod structure
+
+<<sisudoc_spine_pod_dir_structure>>
,* Installation, Compilation
-<<sisudoc_spine_readme_install_summary>>
+<<sisudoc_spine_README_install_summary>>
,* Document processing examples
-<<sisudoc_spine_readme_commands>>
+<<sisudoc_spine_README_commands>>
#+END_SRC
**** org header
-#+NAME: sisudoc_spine_readme_org_header_org
+#+NAME: sisudoc_spine_README_header_org
#+BEGIN_SRC text
-*- mode: org -*-
-#+TITLE: spine (sisudoc) (project) README
-#+DESCRIPTION: README for spine
-#+FILETAGS: :spine:build:tools:
-#+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
-#+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t
-#+PROPERTY: header-args :exports code
-#+PROPERTY: header-args+ :noweb yes
-#+PROPERTY: header-args+ :eval no
-#+PROPERTY: header-args+ :results no
-#+PROPERTY: header-args+ :cache no
-#+PROPERTY: header-args+ :padline no
+,#+TITLE: spine (sisudoc) (project) README
+,#+DESCRIPTION: README for spine
+,#+FILETAGS: :spine:build:tools:
+,#+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
+,#+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t
+,#+PROPERTY: header-args :exports code
+,#+PROPERTY: header-args+ :noweb yes
+,#+PROPERTY: header-args+ :eval no
+,#+PROPERTY: header-args+ :results no
+,#+PROPERTY: header-args+ :cache no
+,#+PROPERTY: header-args+ :padline no
#+END_SRC
-*** md
+*** md contents tangle
#+HEADER: :tangle "../README.md"
#+HEADER: :noweb yes
#+BEGIN_SRC markdown
-<<sisudoc_spine_readme_project_header_info>>
+<<sisudoc_spine_README_project_header_info>>
# Summary
-<<sisudoc_spine_readme_summary>>
+<<sisudoc_spine_README_summary>>
# Installation, Compilation
-<<sisudoc_spine_readme_install_summary>>
+<<sisudoc_spine_README_install_summary>>
+
+# sisudoc-spine pod structure
+
+<<sisudoc_spine_pod_dir_structure>>
# Document processing examples
-<<sisudoc_spine_readme_commands>>
+<<sisudoc_spine_README_commands>>
#+END_SRC
** project header
-#+NAME: sisudoc_spine_readme_project_header_info
+#+NAME: sisudoc_spine_README_project_header_info
#+BEGIN_SRC yaml
project_name: "sisudoc spine (doc reform) markup samples"
@@ -118,7 +126,7 @@ git:
** summary - short description
-#+NAME: sisudoc_spine_readme_summary
+#+NAME: sisudoc_spine_README_summary
#+BEGIN_SRC text
These are document markup samples for the program sisudoc-spine prepared in the
markup language sisu. The markup of document headers for sisudoc-spine now use
@@ -153,9 +161,35 @@ or
spine --source --pod [.sst document name]
#+END_SRC
+** sample pod directory
+
+#+NAME: sisudoc_spine_pod_dir_structure
+#+BEGIN_SRC man
+pod (directory may contain multiple documents)
+ └── the_wealth_of_networks.yochai_benkler
+ ├── conf
+ │   └── sisu_document_make
+ ├── media
+ │   ├── image
+ │   │   ├── won_benkler_2_1.png
+ │   │   ├── won_benkler_6_1.png
+ │   │   ├── won_benkler_7_1.png
+ │   │   ├── won_benkler_7_2.png
+ │   │   ├── won_benkler_7_3a.png
+ │   │   ├── won_benkler_7_3b.png
+ │   │   ├── won_benkler_7_4.png
+ │   │   ├── won_benkler_7_5.png
+ │   │   ├── won_benkler_7_6.png
+ │   │   └── won_benkler_9_1.png
+ │   └── text
+ │   └── en
+ │   └── the_wealth_of_networks.yochai_benkler.sst
+ └── pod.manifest
+#+END_SRC
+
** installation
-#+NAME: sisudoc_spine_readme_install_summary
+#+NAME: sisudoc_spine_README_install_summary
#+BEGIN_SRC markdown
These are document markup samples for the program sisudoc-spine and as such
there is no installation that needs to be done. You may use the examples to
@@ -207,7 +241,7 @@ document source to get the desired output.
** commands help
-#+NAME: sisudoc_spine_readme_commands
+#+NAME: sisudoc_spine_README_commands
#+BEGIN_SRC markdown
e.g.: