Adding Table of Contents #2684
Merged
Adding Table of Contents #2684
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- warning: relatively large commit - 24 changes files in total; 9 general scripts, 7 Body.hs scripts, 7 HTML SRS and 1 TeX SRS files Documentation.hs - created new tOfCont named chunk for Table of Contents section generation; exported DocDecl.hs - implemented new TableOfContents DocSection value for DocSection data type - updated function mkDocDesc to include new application for new TableOfContents DocSection data value SRS.hs - imported new tOfCont named chunk item for use in creation of new tOfCont section item - created new tOfContLabel (section) reference item for use in creation of new tOfCont section DocumentLanguage.hs - imported new tOfCont section item - updated sub-function doit to include new application for TableOfContents DocSection data value - implemented new function mkToC to use DocDesc to create the Table of Contents section's contents; implemented new sub-function toToC to assist in creating section contents - implemented new helper functions to assist in creating the various entries in the new Table of Contents section (mkToCSec, mktToCSec, mktRefSec, mktIntroSec, mktStkhldrSec, mktGSDSec, mktSSDSec, mktReqrmntSec, mktLCsSec, mktUCsSec, mktTraceabilitySec, mktAuxConsSec, mktBib, mktAppndxSec, mktOffShelfSolnSec) with sub-functions as needed (mktSubRef, mktSubIntro, mktSub, mktSubSSD, mktSubPD, mktSubSCS, mktSubs) - added new accompanying comment for helper function mkIntroSec Core.hs - added new DocSection data value TableOfContents - added new instance of DLPlate of Multiplate for new TableOfContents DocSection data value Body.hs (for /GamePhysics, /GlassBR, /HGHC, /NoPCM, /Projectile, /SSP, /SWHS) - added new TableOfContents DocSection data value to SRSDecl in function mkSRS - added new import for DocSection data value TableOfContents as needed (for /HGHC, /Projectile) Drasil.hs - added new functions senToStr. getDTle, getDAtr, getDSec, getDDoc, mkUnOrdList, mkTEList and mkTE2List (to assist in reading through the DocDesc and create the ToC section contents) Document.hs - added new functions to assist in reading through the DocDesc and creating the ToC section contents - new functions include getDTle, getDAtr, getDSec, getDDoc, mkUnOrdList, mkUnOrdList_, mkUnOrdList2_, mkTEList and mkTE2List Sentence.hs - implemented/exported new function senToStr to revert Sentence back to String type (applicable only in a few cases) - used to determine if TableOfContents section is in DocDesc; temporary function, likely will be replaced with more robust function Print.hs - imported (new) functions tle (from Section data type). getDTle, getDAtr, getDSec, getDDoc and senToStr - updated implementation of function genTeX to only include Table of Contents generation iff the TableOfContents section was in the Document's contents - implemented new duplicate function buildStd_ to omit the ToC generation (may combine with function buildStd later); added new accompanying comments to differentiate duplicate functions GamePhysics_SRS.html, GlassBR_SRS.html, HGHC_SRS.html, NoPCM_SRS.html, Projectile_SRS.html, SSP_SRS.html, SWHS_SRS.html - updated _SRS.html stable files to include the new (basic) Table of Contents section (unlinked) Template_SRS.tex - updated template SRS stable file to remove automatic inclusion of the Table of Contents section - should the template have the TableOfContents sections included by default? @JacquesCarette @smiths - contributes to Issue #1018
DocumentLanguage.hs
- used record patterns "{}" in place of groups of 3+ blanks ("_ _ _" and longer)
Document.hs
- added new language option TupleSections to top of file
- reduced function getDDoc, removing unneeded explicit parameters
- used tuple-section to streamline/reduce definition for tl (under function mkUnOrdList2_)
- reduced uses of map with function composition
Sentence.hs
- removed redundant brackets
Print.hs
- removed redundant brackets, moved brackets around to avoid use of $
DocumentLanguage.hs - removed redundant brackets from input parameters in several sub-functions as needed
drasil-docLang.cabal - addded new (hidden) module Drasil.Sections.TableOfContents DocumentLanguage.hs - imported new module Dasil.Sections.TableOfContents (to get references/hyperlinking for each section entry in the ToC) - replaced all (S String) Sentences for all ToC entries with (Ref Reference) Sentences for all ToC entries - used imported References from new imported module TableOfContents.hs - created new module Dasil.Sections.TableOfContents - to create references for hyperlinking each section/subsection entry in the ToC Drasil.hs - exports new function makeToCRef (imported from module Language.Drasil.Document) Document.hs - created new function makeToCRef to convert two Strings into a Reference, ideally formatted for the ToC section/subsection entries GamePhysics_SRS.html, GlassBR_SRS.html, HGHC_SRS.html, NoPCM_SRS.html, Projectile_SRS.html, SSP_SRS.html, SWHS_SRS.html - updated stable files to include updated Table of Contents with hyperlinked section/subsection entries
JacquesCarette
approved these changes
Jul 18, 2021
|
Needs a master merge, but is otherwise good to go. |
JacquesCarette
approved these changes
Jul 19, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1018
Summary of changes:
SRS.hsfunctions to be in the same order as they appear on a SRS documentSRSDecl