JP2009151727A - Document processing system - Google Patents

Abstract

<P>PROBLEM TO BE SOLVED: To achieve comment description/display function for storing comment information outside a text file and preventing a comment display position from being shifted from the original position even when the text file is significantly changed. <P>SOLUTION: For respective identifiers such as functions and variables defined in a document, the names of the identifiers and comments corresponding to the identifiers are stored as a comment information file outside the text file. When the document is displayed, the definition position of each identifier in the document is recognized, and the comment corresponding to the identifier is retrieved from the comment information file, and the comment is displayed in association with the definition position of the identifier. <P>COPYRIGHT: (C)2009,JPO&INPIT

Description

  The present invention relates to a document processing system.

  Conventionally, in a word processor or the like, a comment can be described for a specific portion of a document, and the comment has a function of being displayed not in the document display screen but in another window.

  Conventional implementation means include a method of embedding comment information and ID in a document file, and a method of storing comment information together with position information outside the document file.

  If you embed comment information in a document file, the position of the comment will not change even if you edit it, but you will need to change the document file itself when you write the comment. Cannot be used if there is no authority.

When the comment information is stored together with the position information outside the document file, the comment can be described without changing the document file. However, if the document is edited, the position of the comment may be changed. As a means for solving this problem, there is a method of storing the content of the document at the comment adding position together with the position information, and after editing the document, searching the content from the periphery of the position to determine the comment position ( Patent 316695).
Patent 3166995

  When comment information is stored together with position information outside the document file, the position of the comment may change when the document is edited. As a means for solving this problem, there is a method of storing the content of the document at the comment giving position together with the position information, searching the content from the periphery of the position after editing the document, and determining the comment position. If the amount of change is large, there is a risk that a character string with the same content is not found in the search range or matches another part.

  An object of the present invention is to realize a comment description / display function in which comment information is stored outside a document file and the comment display position does not deviate from the original position even if a large change is made to the document file. is there.

  Documents such as program source code do not store comments along with location information, but store significant comments along with identifier names such as function names and variable names. As long as the definition of the function or variable is not deleted, a comment can always be displayed at the definition position.

  The invention according to claims 1 to 3 for solving this problem is a system configured as shown in FIG.

  Reference numeral 1 denotes document storage means for storing a document.

  Reference numeral 2 denotes comment information storage means for storing a plurality of records each including a name of an identifier defined in a document and comment information for the identifier.

  Reference numeral 3 denotes grammar recognition processing means for reading out a document from the document storage means 1 and recognizing the name and definition position of the identifier defined in the document.

  Reference numeral 4 denotes display processing means for searching for a record with a matching identifier name from the comment information storage means 2 for the identifier recognized by the grammar recognition processing means 3, and associating the comment information of the matching record with the definition position of the identifier. To display.

  This system updates the name of the identifier stored in the comment information storage unit 2 when the edited document is stored in the document storage unit 1 after editing the document.

  Further, by placing the comment information storage unit 2 on a server accessible via a network, the comment information can be shared by a plurality of users.

  According to the present invention, it is possible to realize a comment description / display function in which comment information is stored outside a document file and the comment display position does not deviate from the original position even if a large change is made to the document file.

  Since the comment information is stored outside the document file, it is possible to describe a comment even if the user does not want to change the document file or has no editing authority.

  Further, even if a large change is made to the document file, the comment display position does not deviate from the original position, so that no maintenance cost for correcting the comment display position is required. Further, it is possible to ensure the reliability that the comment display position is not moved.

  Since the comment description on the document file itself is referred to by all persons related to the document, there are cases where restrictions such as inability to describe uncertain information and frank phrases may occur. According to the present invention, each person in charge can more easily describe a comment. In addition, when comment information is shared by a plurality of users, free information exchange between persons in charge can be promoted. Thereby, it can contribute to the efficiency improvement and quality improvement of document preparation.

  In addition, since the know-how information that is live on the spot, such as comment information during document creation work, can be transferred to the future at a low cost, it is possible to contribute to the efficiency and quality improvement of future document creation.

  An embodiment of the present invention will be described with reference to FIGS. 2 is a block diagram of an embodiment of the present invention, FIG. 3 is an example of information stored in a comment information file, and FIG. 4 is a screen display example. The document processing system according to the present embodiment has a display function / editing function as a standard text editor, but a configuration diagram and description of portions not directly related to the present invention are omitted.

  In FIG. 2, 1a is a document file, 2a is a comment information file, 3 is a grammar recognition means, and 4 is a display processing means.

  The document file 1a stores document data. The document file 1a is placed on the storage medium of the local PC or the storage medium of the server.

  In many cases, the document file 1a is one file in a group of several document files created to provide the same product or service. Hereinafter, this collection of several document files is called a project.

  In the comment information file 2a, a plurality of records including fields of {file path, identifier, comment, user, date and time} are stored. The file path of the document file is stored in the “file path” field. The “identifier” field stores the name of the identifier defined in the document. The user name of the user who wrote the comment is stored in the “user” field, and the date and time when the comment is written is stored in the “date and time” field.

  FIG. 3 is an example of information stored in the comment information file 2a. The first record stores comment information for the identifier “function1” of the file with the file path “common / file1.c”. The second record stores comment information for the identifier “var1” in the scope of the identifier “function1” of the file with the file path “common / file1.c”. Note that in the document of this example, function 1 is a function and var 1 is a local variable, but the identifier type is not stored in the comment information file 2a, and only the name is stored.

  The comment information file 2a is placed on the storage medium of the local PC or the storage medium of the server. Access to the comment information file 2a on the server uses an OS standard file access protocol such as SMB (Server Message Block), FTP protocol, or the like. Access to the comment information file 2a is performed by exclusive control. If another user is writing, the comment information file 2a is accessed after waiting for the writing to be completed. If the protocol does not have an exclusive control function, exclusive control is realized by generating an empty file (lock file) indicating that writing is being performed in the same directory during writing.

  The comment information file 2a can store comment information for each document file in the same project in one comment information file.

  Further, the document processing system allows the user to specify the location of the comment information file 2a and the project root directory in advance. Alternatively, in accordance with the type and location of the document file 1, the location of the comment information file 2a and the information on the project root directory preset by the user are read and used. The “file path” field of the comment information file 2a is processed by regarding it as a relative path from the root directory of the project.

  The root directory of the project is not saved in the comment information file 2a. This is because, when the comment information file 2a is placed on a file server and shared by multiple users, the document file 1 often exists in the working directory of each person in charge on the local PC, and the project root directory is each person in charge. This is because it is better to be able to set for each person. Also, you can handle different versions of the project at the same time, but you may want to use the same comment information file, so it is better to set the project root directory individually.

  The document processing system opens a comment input dialog when the user clicks the add comment button while a part of the document is selected on the document display screen. When a comment is input by the user and the OK button is clicked, a record is added to the comment information file 2a. The “identifier” field stores the name of the identifier defined closest to the selected location on the document display screen. In the case of an identifier having a scope, such as a local variable, the name of an identifier (function or the like) that defines the scope (hereinafter referred to as a scope identifier) is also stored. The file path of the document being processed is entered in the File Path field, the comment entered by the user in the Comment field, the user name of the user who entered the comment in the User field, and the current date and time in the Date / Time field Is stored.

  The grammar recognition processing means 3 reads a document from the document file 1a, and recognizes the identifier name and definition position defined in the document. As a recognition method, a method of using the same principle as a compiler or a method of recognizing according to a rule defined by a user can be considered. In this embodiment, a system described in Japanese Patent Application No. 2007-248057 is used as one of methods for recognizing according to rules defined by the user.

  First, the display processing means 4 displays the contents at the current scroll position among the contents of the document file 1a on the window screen. For each identifier whose definition position is displayed in the window screen, from the comment information file 2a, the “file path” field matches the file path of the document being processed, and the “identifier” field is the identifier. Search for a record that matches the name. If there is a matching record, create a window near the right end of the document display window with the same Y coordinate as the display position of the identifier definition, and set the "Comment", "User", and "Date / time" fields for all the matching records. indicate. Further, highlighting such as enclosing the display position of the definition of the identifier with a square is performed, and a window displaying a comment (hereinafter referred to as a comment window) is connected with a dotted line. The title of the comment window displays the identifier name and identifier type.

  In the above-described process for searching for a record in which the “identifier” field matches the identifier name, if the target identifier has a scope, the scope identifier of the target identifier is changed to the scope identifier described in the “identifier” field. Matching is also added to the condition. Note that the scope identifier of the target identifier is, for example, a local variable, and is determined by considering the function definition first found by searching forward from the definition position as the scope identifier.

  When the screen is scrolled, the comment window is also moved in synchronization. The comment window corresponding to the identifier whose definition position is no longer displayed is deleted, and the new comment window is displayed by performing the above-described processing for the newly displayed identifier.

  FIG. 4 is a screen display example of the example comment information file shown in FIG. A part of the document file “file1.c” is displayed on the window screen, and comment information for the identifiers “function1” and “var1” being displayed in the window screen is displayed in a separate window. For example, the comment display for the identifier “var1” is obtained as follows. In the display processing means 4, since “var1” in the window screen display is a local variable and the scope identifier is “function1”, the “file path” field of the comment information file 2a is “file1.c”, and , A record in which “function1” and “var1” are described in the “identifier” field is searched to obtain the second record and the third record. The display processing means 4 displays a comment window near the right end of the document display window with the same Y coordinate as the definition position of “var1”, and displays the “comment”, “user”, and “date / time” fields of the second and third records. indicate.

  A user or administrator who has written a comment can edit or delete the comment in the window in which the comment is written. When the comment is edited / deleted, the document processing system stores the edited result in the comment information file 2a.

  Also, the user can add a new comment to an identifier that already has a comment. In this case, a new record is added to the comment information file 2a.

  In addition, when the identifier name is changed as a result of editing the document, the document processing system stores the old identifier name and the new identifier name as a set. When the edited document is stored in the document file 1a, the "file path" field matches the file path of the document being processed from the comment information file 2a, and the "identifier" field is the old identifier name. Search for a matching record and replace the old identifier name in the “identifier” field of the matched record with the new identifier name.

  In the above-described processing, the determination method of “whether or not the identifier name has been changed” as a result of editing the document is as follows. If the identifier is originally defined in the line to be edited, and the identifier name newly defined in the line is different from the old identifier name as a result of editing, it is considered that the identifier name has been changed.

  Note that the reference to the comment information file 2a speeds up processing by using cache data stored in the RAM. The cache data is updated when the document is saved, when the comment information file update notification is received, when the timer expires, or when an instruction from the user is given.

  In addition, not only programming language identifiers but also chapters and sections in general documents that can be defined in accordance with certain rules and have names, are used as “identifiers” in the present invention. be able to.

  Also, in the comment window, not only comments but also additional information related to the identifier (for example, function call source information, links to the call source, number of call locations, links to header files, locations that are likely to be affected) It is possible to add a function that displays a link to

  In addition, each user who has referred to a comment can input feedback as to whether or not the comment is useful, save the result in the comment information file 2a, and display a comment with high usefulness preferentially. Addition is possible.

  In addition, it is possible to add a function to display a “response completed” check box in the comment window so that it can be used as a to-do list for confirming countermeasures for review indications. In this case, when updating the check box, the document processing system stores the On / Off information of the “correspondence complete” check box in the comment information file 2a.

  Furthermore, it is conceivable to add a function for limiting a comment to be displayed by setting a condition such as date and time, performing a keyword search for the comment information file, and creating a report file based on the comment information file.

It is a principle block diagram of this invention. It is a block diagram of embodiment of this invention. It is an example of the information memorize | stored in the comment information file. It is an example of a screen display.

Explanation of symbols

DESCRIPTION OF SYMBOLS 1 Document memory | storage means 2 Comment information storage means 3 Grammar recognition processing means 4 Display processing means 1a Document file 2a Comment information file

Claims (3)

Document storage means for storing a document;
Comment information storage means for storing a plurality of records including a name of an identifier defined in a document and comment information for the identifier;
Grammar recognition processing means for reading a document from the document storage means and recognizing the name and definition position of an identifier defined in the document;
For the identifier recognized by the grammar recognition processing means, search the record that matches the identifier name from the comment information storage means, and display the comment information of the matched record in association with the definition position of the identifier. It is characterized by
Document processing system. After editing the document, when storing the edited document in the document storage unit, the identifier name stored in the comment information storage unit is updated.
The document processing system according to claim 1. The comment information storage means is placed on a server accessible via a network,
The document processing system according to claim 1 or 2.

Images