Table of Contents - minireq-0.1.7 Documentation
Pages
- README
- user-stories
-
web
- Web interface
- User stories
- Functional requirements
- [core] Core
- [core.user] User
- [core.user.data] User data
- [core.user.repo] Users repository
- [core.user.repo.add] Add user to repository
- [core.user.repo.add.para] Add user parameters
- [core.user.repo.add.exist] User exist
- [core.com] Comment
- [core.com.data] Comment data
- [core.com.repo] Comments repository
- [core.cmd] Commands
- [sec] Security
- Simple HTTP Authentication
- Storing passwords in MD5
- [intf] Interface
- [cli] CLI
- [cli.adduser] adduser
- [cli.startsever] startsever
- [cli.comments] comments command
- [web]
- [web.auth] Authentication
- [web.page] Single page web application
- [web.page.parts] Parts
- [web.page.header] Header
- [web.page.navigator] Contents navigator pane
- [web.page.content] Content pane
- [web.page.comment] Comments pane
- [web.page.comment.create] New comment form
- [web.page.comment.history] Comments history
- [web.page.comment.history.onlymine] All/Only mine
- [web.page.comment.history.alltags] All/Only tag
- Design constraints
- Dependencies
- gem packing
-
requirements
- Functional requirements {#f}
- [core] Core {#core}
- [core.req] Requirement {#core-req}
- [core.req.data] Requirement data {#core-req-data}
- [core.req.file] Reading requirement from a file {#core-req-file}
- [core.req.file.attr] Attributes excerpt {#core-req-file-attr}
- [core.req.file.attr.key] Key and Value {#core-req-file-attr-key}
- [core.req.file.attr.sys] System attributes {#core-req-file-attr-sys}
- [core.req.file.struct] Headers structure {#core-req-file-struct}
- [core.doc] Document {#core-doc}
- [core.doc.data] Document data {#core-doc-data}
- [core.doc.load] Requirements loading {#core-doc-load}
- [core.doc.load.hrch] Hierarchy building {#core-doc-load-hrch}
- [core.doc.load.sort] Sort child requirements {#core-doc-load-sort}
- [core.doc.chk] Check requirements {#core-doc-chk}
- [core.doc.chk.dup] Duplicate id {#core-doc-chk-dup}
- [core.doc.chk.lnk] Wrong links {#core-doc-chk-lnk}
- [core.doc.create] Create requirements document {#core-doc-create}
- [core.doc.create.header] Writing headers {#core-doc-create-header}
- [core.doc.create.header.skipid] 'suppress_id' system attribute {#core-doc-create-header-skipid}
- [core.doc.create.attr] Attributes section {#core-doc-create-attr}
- [core.doc.create.body.links] Replace links macro {#core-doc-create-body-links}
- [core.doc.create.check] Check document for errors {#core-doc-create-check}
- [dsl] DSLs {#dsl}
- [dsl.trace] Trace DSL {#dsl-trace}
- [dsl.trace.skip] Skip {#dsl-trace-skip}
- [dsl.trace.from] From {#dsl-trace-from}
- [dsl.pert] PERT DSL {#dsl-pert}
- [dsl.pert.skip] Skip {#dsl-pert-skip}
- [dsl.trace.pert] Pert {#dsl-trace-pert}
- [dsl.pert.calc] Calculate {#dsl-pert-calc}
- [dsl.pert.dup] Duplicates {#dsl-pert-dup}
- [dsl.fpa] FPA DSL {#dsl-fpa}
- [dsl.fpa.skip] Skip {#dsl-fpa-skip}
- [dsl.fpa.ilf] ILF (Internal Logical File) {#dsl-fpa-ilf}
- [dsl.fpa.eif] EIF (External Interface File) {#dsl-fpa-eif}
- [dsl.fpa.ei] EI (External Input) {#dsl-fpa-ei}
- [dsl.fpa.eo] EO (External Output) {#dsl-fpa-eo}
- [dsl.fpa.eq] EQ (External Inquiry) {#dsl-fpa-eq}
- [dsl.fpa.sysch] Characteristics {#dsl-fpa-sysch}
- [dsl.fpa.calc] Calculate {#dsl-fpa-calc}
- [dsl.fpa.dup] Duplicates {#dsl-fpa-dup}
- [i] Interface requirements {#i}
- [cli] Command line interface {#cli}
- [cli.core] Essential commands {#cli-core}
- [cli.req] req command {#cli-req}
- [cli.req.param] Parameters {#cli-req-param}
- [cli.req.param.attr] Attributes parameter provided {#cli-req-param-attr}
- [cli.req.param.tmpl] Template parameter provided {#cli-req-param-tmpl}
- [cli.req.param.tmpl.mid] Template macro @@id {#cli-req-param-tmpl-mid}
- [cli.req.param.tmpl.mtt] Template macro @@title {#cli-req-param-tmpl-mtt}
- [cli.req.file.name] File name {#cli-req-file-name}
- [cli.req.file.name.exist] Requirement file exists {#cli-req-file-name-exist}
- [cli.doc] doc command {#cli-doc}
- [cli.doc.file] Rewriting requirements.md {#cli-doc-file}
- [cli.chk] chk command {#cli-chk}
- [cli.trace] 'trace' command family {#cli-trace}
- [cli.trace.check] trace check command {#cli-trace-check}
- [cli.trace.check.wrong] Wrong trace {#cli-trace-check-wrong}
- [cli.trace.check.precheck] Precheck {#cli-trace-check-precheck}
- [cli.trace.create] trace create command {#cli-trace-create}
- [cli.trace.create.check] Precheck {#cli-trace-create-check}
- [cli.trace.create.record] Trace record {#cli-trace-create-record}
- [cli.trace.update] trace update command {#cli-trace-update}
- [cli.trace.update.missed] Missed traces {#cli-trace-update-missed}
- [cli.trace.update.check] Precheck {#cli-trace-update-check}
- [cli.pert] 'pert' command family {#cli-pert}
- [cli.pert.check] pert check command {#cli-pert-check}
- [cli.pert.check.wrong] Wrong estimations {#cli-pert-check-wrong}
- [cli.pert.check.precheck] Precheck {#cli-pert-check-precheck}
- [cli.pert.create] pert create command {#cli-pert-create}
- [cli.pert.create.check] Precheck {#cli-pert-create-check}
- [cli.pert.create.record] Pert record {#cli-pert-create-record}
- [cli.pert.update] pert update command {#cli-pert-update}
- [cli.pert.update.missed] Missed estimations {#cli-pert-update-missed}
- [cli.pert.update.check] Precheck {#cli-pert-update-check}
- [cli.fpa] 'fpa' command family {#cli-fpa}
- [cli.fpa.check] fpa check command {#cli-fpa-check}
- [cli.fpa.check.wrong] Wrong estimations {#cli-fpa-check-wrong}
- [cli.fpa.check.precheck] Precheck {#cli-fpa-check-precheck}
- [cli.fpa.create] fpa create command {#cli-fpa-create}
- [cli.fpa.create.check] Precheck {#cli-fpa-create-check}
- [cli.fpa.create.record] FPA record {#cli-fpa-create-record}
- [cli.fpa.update] fpa update command {#cli-fpa-update}
- [cli.fpa.update.missed] Missed estimations {#cli-fpa-update-missed}
- [cli.fpa.update.check] Precheck {#cli-fpa-update-check}
- [api] API {#api}
- [web] Web application {#web}
- Non-functional requirements {#n}
- Design constraints {#d}
- promo.thor
-
_contents
- [f] Functional requirements
- [core] Core
- [dsl] DSLs
- [i] Interface requirements
- [cli] Command line interface
- [cli.core] Essential commands
- [cli.trace] 'trace' command family
- [cli.pert] 'pert' command family
- [cli.fpa] 'fpa' command family
- [api] API
- [web] Web application
- [n] Non-functional requirements
- [d] Design constraints
- cli.chk
- cli.doc
- cli.fpa.check
- cli.fpa.create
- cli.fpa.update
- cli.pert.check
- cli.pert.create
- cli.pert.update
-
cli.req
- [cli.req] req command
- [cli.req.param] Parameters
- [cli.req.param.attr] Attributes parameter provided
- [cli.req.param.tmpl] Template parameter provided
- [cli.req.param.tmpl.mid] Template macro @@id
- [cli.req.param.tmpl.mtt] Template macro @@title
- [cli.req.file.name] File name
- [cli.req.file.name.exist] Requirement file exists
- cli.trace.check
- cli.trace.create
- cli.trace.update
- core.doc.create
- core.doc
- core.req
-
dsl.fpa
- [dsl.fpa] FPA DSL
- [dsl.fpa.skip] Skip
- [dsl.fpa.ilf] ILF (Internal Logical File)
- [dsl.fpa.eif] EIF (External Interface File)
- [dsl.fpa.ei] EI (External Input)
- [dsl.fpa.eo] EO (External Output)
- [dsl.fpa.eq] EQ (External Inquiry)
- [dsl.fpa.sysch] Characteristics
- [dsl.fpa.calc] Calculate
- [dsl.fpa.dup] Duplicates
- dsl.pert
- dsl.trace
- contents
- ears
- ears_examples
- story
- README.md.tt
- creq.thor
Classes and Modules
- Minireq
- Minireq::Cli
- Minireq::Cli::Cli
- Minireq::Cli::FpaCli
- Minireq::Cli::PertCli
- Minireq::Cli::TraceCli
- Minireq::Core
- Minireq::Core::Document
- Minireq::Core::Excerpt
- Minireq::Core::Node
- Minireq::Core::Reader
- Minireq::Core::Requirement
- Minireq::Core::Writer
- Minireq::Data
- Minireq::Data::DslFileMgr
- Minireq::Data::DslFileMixin
- Minireq::Data::FpaDslFile
- Minireq::Data::PertDslFile
- Minireq::Data::TraceDslFile
- Minireq::Dsl
- Minireq::Dsl::Fpa
- Minireq::Dsl::FpaDSL
- Minireq::Dsl::Pert
- Minireq::Dsl::PertDSL
- Minireq::Dsl::TraceDSL
- Object
Methods
- ::new — Minireq::Core::Document
- ::new — Minireq::Core::Node
- ::new — Minireq::Core::Requirement
- ::new — Minireq::Data::DslFileMgr
- ::new — Minireq::Data::FpaDslFile
- ::new — Minireq::Data::PertDslFile
- ::new — Minireq::Data::TraceDslFile
- ::new — Minireq::Dsl::FpaDSL
- ::new — Minireq::Dsl::PertDSL
- ::new — Minireq::Dsl::TraceDSL
- ::root — Minireq
- ::source_root — Minireq::Cli::Cli
- #EI — Minireq::Dsl::FpaDSL
- #EIF — Minireq::Dsl::FpaDSL
- #EO — Minireq::Dsl::FpaDSL
- #EQ — Minireq::Dsl::FpaDSL
- #ILF — Minireq::Dsl::FpaDSL
- #__print_version — Minireq::Cli::Cli
- #calc — Minireq::Cli::FpaCli
- #calc — Minireq::Cli::PertCli
- #calc — Minireq::Cli::TraceCli
- #calc — Minireq::Data::DslFileMgr
- #calc_e95 — Minireq::Dsl::Pert
- #calc_pert — Minireq::Dsl::Pert
- #calculate — Minireq::Dsl::FpaDSL
- #calculate — Minireq::Dsl::PertDSL
- #characteristics — Minireq::Dsl::FpaDSL
- #check — Minireq::Cli::Cli
- #check — Minireq::Cli::FpaCli
- #check — Minireq::Cli::PertCli
- #check — Minireq::Cli::TraceCli
- #check — Minireq::Data::DslFileMgr
- #check_errors — Minireq::Core::Document
- #check_nonuniq_ids — Minireq::Core::Document
- #check_wrong_links — Minireq::Core::Document
- #create — Minireq::Cli::FpaCli
- #create — Minireq::Cli::PertCli
- #create — Minireq::Cli::TraceCli
- #create — Minireq::Data::DslFileMgr
- #create_project — Minireq::Cli
- #create_requirement_source — Minireq::Cli
- #doc — Minireq::Cli::Cli
- #dsl_func — Minireq::Data::FpaDslFile
- #dsl_func — Minireq::Data::PertDslFile
- #dsl_func — Minireq::Data::TraceDslFile
- #dsl_func — Minireq::Data::DslFileMixin
- #estimate — Minireq::Dsl::FpaDSL
- #estimate — Minireq::Dsl::PertDSL
- #excerpt_to_hash — Minireq::Core::Excerpt
- #file_exist? — Minireq::Data::DslFileMgr
- #find — Minireq::Core::Document
- #from — Minireq::Dsl::TraceDSL
- #get_document — Minireq::Cli
- #get_ids — Minireq::Core::Document
- #get_ids — Minireq::Core::Node
- #get_links — Minireq::Core::Requirement
- #get_url — Minireq::Core::Writer
- #hash_to_excerpt — Minireq::Core::Excerpt
- #hash_to_markdown_table — Minireq::Core::Writer
- #hierarchize — Minireq::Core::Document
- #hold — Minireq::Dsl::FpaDSL
- #inassets — Minireq::Cli
- #include? — Minireq::Data::DslFileMixin
- #indoc — Minireq::Cli
- #init — Minireq::Cli::Cli
- #inreq — Minireq::Cli
- #intpt — Minireq::Cli
- #item_dsl — Minireq::Data::FpaDslFile
- #item_dsl — Minireq::Data::PertDslFile
- #item_dsl — Minireq::Data::TraceDslFile
- #item_dsl — Minireq::Data::DslFileMixin
- #level — Minireq::Core::Node
- #load — Minireq::Core::Document
- #load — Minireq::Data::FpaDslFile
- #load — Minireq::Data::PertDslFile
- #load — Minireq::Data::TraceDslFile
- #make_link — Minireq::Core::Writer
- #markdow_header_level — Minireq::Core::Reader
- #new — Minireq::Cli::Cli
- #objects — Minireq::Data::DslFileMixin
- #parent_id — Minireq::Core::Requirement
- #parse_requirement — Minireq::Core::Reader
- #pert — Minireq::Dsl::PertDSL
- #promo — Minireq::Cli::Cli
- #read_file — Minireq::Core::Reader
- #read_requirement_files — Minireq::Core::Reader
- #replace_links — Minireq::Core::Writer
- #req — Minireq::Cli::Cli
- #requirement_text_to_hash — Minireq::Core::Reader
- #requirement_to_text — Minireq::Core::Writer
- #save — Minireq::Data::DslFileMixin
- #simple_cocomo — Minireq::Dsl
- #skip — Minireq::Data::DslFileMixin
- #skip_dsl — Minireq::Data::DslFileMixin
- #sort_childs — Minireq::Core::Requirement
- #system_attribute? — Minireq::Core::Requirement
- #system_attributes — Minireq::Core::Requirement
- #title — Minireq::Core::Writer
- #to_a — Minireq::Core::Node
- #trace — Minireq::Dsl::TraceDSL
- #ufp — Minireq::Dsl::Fpa
- #update — Minireq::Cli::FpaCli
- #update — Minireq::Cli::PertCli
- #update — Minireq::Cli::TraceCli
- #update — Minireq::Data::DslFileMgr
- #user_attributes — Minireq::Core::Requirement
- #vaf — Minireq::Dsl::Fpa
- #visit — Minireq::Core::Document
- #visit — Minireq::Core::Node
- #write_doc — Minireq::Cli
- #write_document — Minireq::Core::Writer
- #write_req — Minireq::Cli
- #write_requirement — Minireq::Core::Writer
- #write_requirement_source — Minireq::Core::Writer