Online Amateur Radio Community Wiki

User Tools

Site Tools

Trace: • howtos • software_building • man3 • referencelibrary • packet-node-station-cookbook • man9 • man6 • parsing • man7
packet:xrouter:docs:parsing

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
packet:xrouter:docs:parsing [2025/04/26 18:56] – m0mzfpacket:xrouter:docs:parsing [2025/04/26 21:44] (current) – m0mzf
Line 70: Line 70:
 OUTPUTDIR="$BASEPATH/docuwiki-$DATE" OUTPUTDIR="$BASEPATH/docuwiki-$DATE"
 INDEXFILE="${OUTPUTDIR}"/index.docuwiki INDEXFILE="${OUTPUTDIR}"/index.docuwiki
- 
-# Wiki MANPAGE namespace structure. We pass this into awk later but define it here 
- 
  
 # Handy functions # Handy functions
Line 88: Line 85:
 } }
  
 +# awk functions
 awkFormatIndexMANTitle=' awkFormatIndexMANTitle='
 { {
Line 104: Line 102:
 awkParseMan=' awkParseMan='
 { {
- if (NR>=(recs - 1) && flag==0) {print "</code>" ; exit} # If we have EOF and didn't have a see also line write code close and exit + if (NR>=(recs - 1) && flag==0) {print "</code>" ; exit} # If we have EOF and didnt have a SEE ALSO section write code close and exit 
- if (NR>=(recs - 1) && flag==1) {print "" ; exit} # If we are EOF and have a see also line write nothing and exit+ if (NR>=(recs - 1) && flag==1) {print "" ; exit} # If we are EOF and have a SEE ALSO section write nothing and exit
  
  if (NR==1 || NR==2) # For the first two lines  if (NR==1 || NR==2) # For the first two lines
Line 114: Line 112:
  }  }
  
- if (NR>=3 && NR<recs) # For the other items leading up toEOF+ if (NR>=3 && NR<recs) # For the other items leading up to EOF
  {  {
  FS="[()]" # Field separator so we can generate section & title  FS="[()]" # Field separator so we can generate section & title
Line 123: Line 121:
  print "</code> **SEE ALSO:** \\\\" # Output a reformatted see also line  print "</code> **SEE ALSO:** \\\\" # Output a reformatted see also line
  }  }
- else if (NR>lno && NR<(recs -1) && NF>0) # If we're in see also and are not EOF and have non-empty lines+ else if (NR>lno && NR<(recs -1) && NF>0) # If we are in SEE ALSO and are not EOF and have non-empty lines
  {  {
  line=$0 # Save the inital line to print later  line=$0 # Save the inital line to print later
Line 130: Line 128:
  lno++  lno++
  }  }
- else if (/^[A-Z]/)  # If the line begins with a character+ else if (/^[A-Z]/)  # If the line begins with a character
  {  {
  starthead="</code> **" # end previous code block  starthead="</code> **" # end previous code block
Line 157: Line 155:
 ' '
  
 +# File enumerator / reader / writer
 parseFiles () { parseFiles () {
  mkdir "${OUTPUTDIR}/$1"  mkdir "${OUTPUTDIR}/$1"
Line 179: Line 178:
  do  do
  case "$1" in  case "$1" in
- # For MAN files, after awk has done it's job we need to remove the last two lines; this last line breaks 
- # the following <code> statement and is just an EOF message, the penultimate line is blank so we don't lose anything. 
  MAN)  MAN)
  # Section 8 has links to actual real filenames which we want to keep  # Section 8 has links to actual real filenames which we want to keep
Line 193: Line 190:
  # Begin by writing a docuwiki header containing file name  # Begin by writing a docuwiki header containing file name
  echo "===== $title =====" >> "$outputpath"  echo "===== $title =====" >> "$outputpath"
 + # Get line count for the file
  recs=$(wc -l "$file" | awk '{print $1}')  recs=$(wc -l "$file" | awk '{print $1}')
 + # Parse the file!
  awk -v flag=0 -v recs="$recs" -v lno=99999 -v ns="$NAMESPACE" "$awkParseMan" "$file" >> "$outputpath"  awk -v flag=0 -v recs="$recs" -v lno=99999 -v ns="$NAMESPACE" "$awkParseMan" "$file" >> "$outputpath"
 + # Add a link back to index page
 + echo "[[$NAMESPACE|< Back to Index]]" >> "$outputpath"
  # Add a line break after each MAN entry  # Add a line break after each MAN entry
- echo -e "\n\n----\n\n" >> "$outputpath"+ echo -e "\n----" >> "$outputpath"
  # and add an entry to the index  # and add an entry to the index
  echo "$section" | awk -v ns="$NAMESPACE" -v ti="$title" "$awkFormatIndexMANTitle" >> "$INDEXFILE"  echo "$section" | awk -v ns="$NAMESPACE" -v ti="$title" "$awkFormatIndexMANTitle" >> "$INDEXFILE"
  ;;  ;;
- # For HLP files we don't want to remove the last line because that truly is real content 
  HLP)  HLP)
  local title=$(echo $file | awk -F/ '{print $NF}' | awk -F. '{print $1}')  local title=$(echo $file | awk -F/ '{print $NF}' | awk -F. '{print $1}')
Line 206: Line 206:
  awk "$awkParseHlp" "$file" >> "$outputpath"  awk "$awkParseHlp" "$file" >> "$outputpath"
  echo "</code>" >> "$outputpath"  echo "</code>" >> "$outputpath"
 + # Add a link back to index page
 + echo "[[$NAMESPACE|< Back to Index]]" >> "$outputpath"
  echo "$section" | awk -v ns="$NAMESPACE" -v ti="$title" "$awkFormatIndexHLPTitle" >> "$INDEXFILE"  echo "$section" | awk -v ns="$NAMESPACE" -v ti="$title" "$awkFormatIndexHLPTitle" >> "$INDEXFILE"
  ;;  ;;
Line 219: Line 221:
 mkdir "$OUTPUTDIR" mkdir "$OUTPUTDIR"
 echo "======= XRouter Documentation =======" >> "$INDEXFILE" echo "======= XRouter Documentation =======" >> "$INDEXFILE"
-echo "The content below is auto-generated from the XRouter documentation using [[$NAMESPACE:parsing|this bash / awk script]] to parse MAN / HLP files into docuWiki some simple markup language" >> "$INDEXFILE" +echo "This content is auto-generated from the XRouter documentation using [[$NAMESPACE:parsing|this bash / awk script]] to parse MAN / HLP files into docuWiki some simple markup language" >> "$INDEXFILE" 
-echoGreen "Parsing MAN files from $MANFILES"+echoGreen "Parsing MAN files from $MAN"
 parseFiles MAN parseFiles MAN
-echoGreen "Parsing HLP files from $HLPFILES"+echoGreen "Parsing HLP files from $HLP"
 parseFiles HLP parseFiles HLP
-#echoGreen "Parsing DOC files from $DOCFILES"+#echoGreen "Parsing DOC files from $DOC"
 #parseFiles DOC #parseFiles DOC
 </file> </file>
packet/xrouter/docs/parsing.1745693804.txt.gz · Last modified: by m0mzf