.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "KinoSearch1::Document::Doc 3pm"
.TH KinoSearch1::Document::Doc 3pm 2024-03-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
KinoSearch1::Document::Doc \- a document
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&    my $doc = $invindexer\->new_doc;
\&    $doc\->set_value( title    => $title );
\&    $doc\->set_value( bodytext => $bodytext );
\&    $invindexer\->add($doc);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A Doc object is akin to a row in a database, in that it is made up of several
fields, each of which has a value.
.PP
Doc objects are only created via factory methods of other classes.
.SH METHODS
.IX Header "METHODS"
.SS "set_value get_value"
.IX Subsection "set_value get_value"
.Vb 2
\&    $doc\->set_value( title => $title_text );
\&    my $text = $doc\->get_value( \*(Aqtitle\*(Aq );
.Ve
.PP
\&\f(CW\*(C`set_value\*(C'\fR and \f(CW\*(C`get_value\*(C'\fR are used to modify and access the values of the
fields within a Doc object.
.SS "set_boost get_boost"
.IX Subsection "set_boost get_boost"
.Vb 1
\&    $doc\->set_boost(2.5);
.Ve
.PP
\&\f(CW\*(C`boost\*(C'\fR is a scoring multiplier.  Setting boost to something other than 1
causes a document to score better or worse against a given query relative to
other documents.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2005\-2010 Marvin Humphrey
.SH "LICENSE, DISCLAIMER, BUGS, etc."
.IX Header "LICENSE, DISCLAIMER, BUGS, etc."
See KinoSearch1 version 1.01.