On 30.07.21 11:28, spiralofhope wrote:> I also mean that if there are
any complex ideas or words, those can be
> explained in separate specific-documentation in the same way that
code
> does it.
My preferred method for nesting descriptive prose, and presenting the
whole on one page, is to use folding in vim. Over the decades, I've
accumulated around 420 pages of problem diagnoses and solutions,code
builds, toolchain builds, command options, little bits of howto, etc,
in defence against wetware RAM dropouts. (More frequent in my 60s.)
The initial view is a TOC:
UNIX USER ENVIRONMENT &
TOOLS 73 P
TEXT / OFFICE TOOLS &
PRINTING 63 P
DRAWING
TOOLS
19 L
LINUX SYSTEM
ADMINISTRATION 172 P
PROGRAMMING & EMBEDDED
TOOLS 120 P
CAD
1 P
LinuxCNC:
EMC2: CNC: 13
P
The fifth TOC line, for example, expands to:
PROGRAMMING &
EMBEDDED TOOLS {{{
GNU Manuals: http://www.gnu.org/manual/manual.html
ASSEMBLER:---------------------------GAS:------------ASM:----------------AS:
5 P
BINUTILS:-------------------------------------------------------------------
63 L
BISON:-------------------------------YACC:----------------------------------
4 P
BITSCOPE:-------------------------------------------------------------------
1 P
BOOT: Debugging: |See BOOT
DEFAULTS:|
2 P
CONFIGURE:-------------------------------------------------------------CONF:
15 L
C:-----------------------------------CODE:----------------------------------
16 L
CTAGS:----------------------------------------------------------------------
29 L
ENDIAN:----------------------------------------------------------ENDIANNESS:
29 L
FLEX:-----------------------------------------------------------------------
2 P
GCC:--------------------------------- G++
-------------------------COMPILER: 30 P
GNU:-------------------------------CONTRIBUTING:------------------COPYRIGHT:
51 L
LIBRARIES:-------------------------ARCHIVES-------------------------------AR:
1 P
LINKER:---------------------------- man ld
----------------------------- LD: 14 P
Other
BINUTILS:
4 P
LINT:
40 L
MAKE:---------------------------------------------------------------makefile
2 P
MALLOC:---------------------------------------------------------------------
4 P
DDD:----------------------------------------------------------------DEBUGGER
22 L
GDB:----------------------------------------------------------------DEBUGGER
5 P
DEJAGNU:-------------------------------------------------------------DejaGnu
46 L
...
And each of these expand further. The line/page counts are custom
scripted,so not obligatory. I've used folding markers, which contain
each fold, justlike a 'C' code block. There are other folding methods.
For quicker search hits, I just capitalise any keyword and follow it
with a colon.A search hit opens the containing fold, even if it is
seven levels down.There's a lot to like, I find. (Including no damn
GUI within cooee.)
Erik
P.S. To explain words as code does it, we could use ctags, but would
need an
awk script to generate the tags file, I figure. ;-)
_______________________________________________
Dng mailing list
Dng@lists.dyne.org
https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/dng
