Previous Next Functional Tool Requirements Homepage  
3.3 Service Complex: User Interface  
SUI04 - Treatment of Documentation  

  LNSS04 - Dokumentation aufbereiten

Contents  
  • 1 Allocation to V-Model and Methods Allocation
  • 2 Brief Characteristics
  • 3 Requirements
  •       3.1 Requirements for Interfaces
  •       3.2 Requirements for the Methods Support
  •       3.3 Requirements for Functions
  •       3.4 Other Requirements

    • 1 Allocation to V-Model and Methods Allocation

    not applicable

    2 Brief Characteristics

    This service unit defines the requirements for tools applied for the editing of results (text and graphic) in the sense of a uniform documentation with appropriate layout.
    During the development process it is possible to generate incomplete documentation. The possibility also exists of generating partial documentation (different level of detail, points of interest, etc.) by means of direct selection. These service units cannot only be used in connection with the development documentation but also to generate suitable manuals to be handed over to the end user. Furthermore, the service unit can be utilized for the generation of other documents (e. g. Status Reports).

    3 Requirements

    3.1 Requirements for Interfaces

    SUI04.I.1 Input interface to SUI05 - Editing of Texts It is possible to integrate text edited with SUI05 from the object management without further transformation.
    In this case, the term "Without Further Transformation" refers to: umlauts and tabulators are adopted or automatically converted, the formatting information remains stored.
    SUI04.I.2 Input interface to SUI06 - Editing of Graphics It is possible to integrate graphics edited with SUI06 from the object management without further transformation.

    3.2 Requirements for the Methods Support

    none

    3.3 Requirements for Functions

    SUI04.F.1 Formatting
    SUI04.F.1.1 Character formatting
    SUI04.F.1.1.1 Bold/italics/underlined It is possible to attribute at least the printing characteristics "bold", "italics" or "underlined" and their combinations to text.
    SUI04.F.1.1.2 Hidden text It is possible to mark text as "hidden".
    At the time of the printout it is possible to decide if a hidden or invisible text will be printed or not. Hidden text is used for processing advice, notes, and comments, etc.
    SUI04.F.1.2 Paragraph formatting
    SUI04.F.1.2.1 Left/right/centered/block It is possible to align text either left, right, centered or as a block.
    SUI04.F.1.2.2 Line width It is possible to specify the width of a line.
    SUI04.F.1.2.3 Indented second line It is possible to specify an alternative line width for the second line and all following lines in a paragraph.
    This way, it is simple to enter enumerations (by means of dashes, bullets or 1., 2., 3., ...).
    SUI04.F.1.2.4 Connected paragraphs
    SUI04.F.1.2.4.1 Paragraph text It is possible to specify that all lines in a paragraph are only printed together on the same page.
    This way the effort required for page breaks can be considerably reduced.
    SUI04.F.1.2.4.2 Continuation paragraphs It is possible to specify that the succeeding paragraph is printed on the same page.
    SUI04.F.1.3 Document formatting
    SUI04.F.1.3.1 Page size It is possible to specify the size of a document page.
    SUI04.F.1.3.2 DIN A4 DIN A4 is supported in portrait format.
    SUI04.F.1.3.3 Layout
    SUI04.F.1.3.3.1 Multiple use In order to achieve a uniform layout it is possible to specify character and paragraph formatting separately from the actual document and-when generating a document-to refer to the predefined layout.
    SUI04.F.1.4 Later format change
    SUI04.F.1.4.1 Individual changes It is possible to change a specified formatting at a later time.
    This refers to character, paragraph, and document formatting.
    SUI04.F.1.4.2 Range It is possible to change the specified formatting of several connected characters or paragraphs simultaneously at a later time.
    SUI04.F.2 Page editing
    SUI04.F.2.1 Page break
    SUI04.F.2.1.1 Automatic Automatic paging is possible.
    SUI04.F.2.1.2 Forced It is possible to specify the position for a page break.
    SUI04.F.2.2 Headers/footers
    SUI04.F.2.2.1 Unrestricted layout Unrestricted layout for headers and footers is possible.
    SUI04.F.2.2.2 More than one line It is possible that headers and footers consist of more than one line.
    SUI04.F.2.2.3 Chapter-wise modification It is possible to change the content of headers and footers separately for individual chapters.
    SUI04.F.2.2.4 Integration of graphics It is possible that headers and footers include graphics.
    SUI04.F.2.3 Pagination
    SUI04.F.2.3.1 Automatic Automatic pagination with Arabic numbers (1, 2, 3, ...) is possible.
    Further pagination options are: roman (large and small), alphabetical.
    SUI04.F.2.3.2 In headers or footers It is possible to integrate the page numbers optionally in headers or footers.
    SUI04.F.2.3.3 Text before/after page number It is possible to specify preceding or trailing text and/or letters to the page number.
    SUI04.F.2.3.4 Optional begin The user has the possibility to define the first number for the pagination.
    SUI04.F.3 Document structuring
    SUI04.F.3.1 Previous structuring It is possible to generate a previous document structure into which text and graphics can be integrated at some later date.
    SUI04.F.3.2 Later structuring It is possible to generate the document structure at a later time.
    SUI04.F.3.3 Numbering It is possible to generate automatically the numbering of the document structure.
    SUI04.F.3.4 Arabic numbers The numbering of the structure is possible with Arabic numbers in dot notation (e. g. 1.2.1.4).
    SUI04.F.3.5 View change It is possible to switch between structure view and document view.
    The structure view only displays the structural items and offers a better overview of the document structure.
    SUI04.F.3.6 Movable structural items When moving a structural item the corresponding texts/graphics are also moved.
    SUI04.F.3.7 Alterable level It is possible to change the hierarchical level of structural items to a superset or a subset level or back as text.
    SUI04.F.4 Table of contents
    SUI04.F.4.1 Automatic generation It is possible to generate automatically a table of contents with page numbers for the entire document.
    SUI04.F.4.2 Integration of structure When generating a table of contents it is possible to take the "structure" information into consideration.
    SUI04.F.5 Index It is possible to generate an index with page numbers automatically for the entire document.
    SUI04.F.6 Footnotes It is possible to generate footnotes.
    SUI04.F.7 Marking of illustrations
    SUI04.F.7.1 Marking by text It is possible to mark inserted illustrations by text.
    SUI04.F.7.2 List of illustrations It is possible to generate a list of all illustrations.
    SUI04.F.7.3 Numbering It is possible to number the illustrations automatically and consecutively.
    SUI04.F.8 Document reediting
    SUI04.F.8.1 Comments It is possible to comment and to reedit a generated document.
    SUI04.F.8.2 Marking It is possible to specially identify comments and modifications.
    The marking may be realized by a line placed at the side of the page.
    SUI04.F.9 Printout
    SUI04.F.9.1 Complete document It is possible to print out the documentation by means of one command.
    The command can also be entered via a batch file or a macro.
    SUI04.F.9.2 Partial printout It is possible to specify which part of the document is to be printed.
    The page numbers of the first and last page can be specified.
    SUI04.F.9.3 Selective printout It is possible to print out the generated documents in different levels of detail or for different target groups.
    SUI04.F.9.4 Hidden information At the time of the printout it is possible to decide if "hidden" formatted information is to be printed or not.
    SUI04.F.10 Cross references Cross references to page numbers, chapter and illustration numbers are automatically administrated.
    Changes the page number at which a defined text is printed, or, changes the number of a chapter or an illustration, the corresponding references are automatically updated.
    SUI04.F.11 Automatic reproduction of updates Graph and text updates are automatically reproduced in all other documents.
    SUI04.F.12 Hardcopy It is possible to insert hardcopies.
    SUI04.F.13 Variable size It is possible to change the size of an inserted illustration.
    The content of the graphic is adapted to the changed size.
    SUI04.F.14 Documents to be integrated
    SUI04.F.14.1 Simple selection It is possible simply to select texts or graphics to be integrated from a list or something like it.
    SUI04.F.14.2 Reuse It is possible to integrate a text or a graphic into several documents.

    3.4 Other Requirements

    SUI04.O.1 Macros A macro language is used to combine command sequences into a macro.
    SUI04.O.2 Upward compatibility It must be possible to process objects generated with an older release of the tool with the later release of that tool, without loss of information and functionality.
    SUI04.O.3 Complexity There is no limitation of the complexity caused by the tool itself.

    Previous Next GDPA Online Last Updated 01.Jan.2002 Updated by Webmaster Last Revised 01.Jan.2002 Revised by Webmaster