Development/Tutorials/KDE3/Qt Designer and KDevelop 3.0 for Beginners - Revision history

AnneW: Marked this version for translation

2012-01-24T14:39:12Z

Marked this version for translation

Show changes

AnneW at 14:38, 24 January 2012

2012-01-24T14:38:38Z

Show changes

AnneW: /* Getting Spaced Out */

2012-01-24T13:53:42Z

‎Getting Spaced Out

AnneW: /* Adding Widgets */

2012-01-24T12:31:54Z

‎Adding Widgets

AnneW at 12:28, 24 January 2012

2012-01-24T12:28:06Z

AnneW: correct image link

2012-01-23T20:05:30Z

correct image link

AnneW: Markup review 45% complete - continue tomorrow

2012-01-23T20:04:21Z

Markup review 45% complete - continue tomorrow

Show changes

AnneW at 19:25, 23 January 2012

2012-01-23T19:25:14Z

Phanect: Added tags.

2012-01-22T21:27:58Z

Added <translate> tags.

Neverendingo: Text replace - "" to ""

2011-06-29T20:52:15Z

Text replace - "</code>" to "</syntaxhighlight>"

@@ Line 196: / Line 196: @@
 ===Getting Spaced Out===
 This section describes the layout management. If you resize the preview window you will then notice that the widgets do not adjust appropriately. They are not resized. To improve things, we need to use a feature in Qt called spacers. Spacers are like virtual springs that push the widgets on each side apart.
-* '''Note''' - Having a good layout is essential for your application, as when the strings are translated, they might be longer than the English ones and they need to fit on your widgets. The geometry of the widgets has to be nice if the user can resize your window application. Layouts are done by trial and error so use '''Preview->Preview Form''' to see the result of your layout management and to achieve the best layout.
+This section describes the layout management. If you resize the preview window you will then notice that the widgets do not adjust appropriately. They are not resized. To improve things, we need to use a feature in Qt called ''spacers''. Spacers are like virtual springs that push the widgets on each side apart.
 The use of spacers and layout management is a skill that is developed through trial and error. The main thing to remember when dealing with spacers is that you work horizontally first and then vertically.
-We will first use spacers to center the text in the top box. Resize your label so that it only get the size of the text. Then we add two spacers, one at each side. Choose the 'spring' icon or menu '''Layout-> Add Spacer'''. You adjust each of the spacers horizontally. Click the space to the left of the text and the blue spacer will appear . Repeat the same procedure for the right. Then add a spacer on the right of the 'Generated Signature' label, and a last one on the left of the the 'Create!' pushbutton. Please use [[:Image:QtDesigner3-AddingTheSpacers.png|this image]] as a reference.
+[[Image:QtDesigner3-AddingTheSpacers.png|left|thumb|350px]]
-Now that we have spacers to fill blank space, we need a proper layout management. This will allow the widgets to be nicely resized whenever the main window is resized. It is really compulsory to have good layout management. Again, try to resize several times to see if everything is in place. We can use Vertical or horizontal layout or grid management. The top row of widget is horizontal (spacer + label + spacer) so we need Horizontal management. We need to select the three widgets alltogether: click on the first spring, then click on the label while holding down ''Shift'', then on the second spring while holding down ''Shift''. Then click on the Horizontal Layout icon or menu '''Layout-> Lay Out Horizontally'''. You will then see a resizable red line around the three objects to indicate that their layout is being managed. Resize the red box if it needs to.
+Now that we have spacers to fill blank space, we need a proper layout management. This will allow the widgets to be nicely resized whenever the main window is resized. It is really compulsory to have good layout management. Again, try to resize several times to see if everything is in place. We can use Vertical or horizontal layout or grid management. The top row of widget is horizontal (spacer + label + spacer) so we need Horizontal management. We need to select the three widgets alltogether: click on the first spring, then click on the label while holding down <keycap>Shift</keycap>, then on the second spring while holding down Shift. Then click on the <menuchoice>Horizontal Layout icon</menuchoice> or menu <menuchoice>Layout -> Lay Out Horizontally</menuchoice>. You will then see a resizable red line around the three objects to indicate that their layout is being managed. Resize the red box if it needs it.
-We can now repeat this procedure for the three labels inside the GroupBox, this time using vertical layout management. The same vertical management for the two LineEdit and the ComboBox. It is better to use vertical management to keep the object aligned. If we use horizontal management for each label + text box then they will not stay aligned and equally sized. Horizontal management is needed for the label with the spacer and another one for the two pushbuttons and the spacer.
+We can now repeat this procedure for the three labels inside the GroupBox, this time using vertical layout management. The same vertical management is used for the two LineEdit and the ComboBox. It is better to use vertical management to keep the objects aligned. If we use horizontal management for each label + text box then they will not stay aligned and equally sized. Horizontal management is needed for the label with the spacer and another one for the two pushbuttons and the spacer.
-To finish the layout, we need to let the form look after the laid-out boxes. We put everything in a grid. This is done by right clicking the form and selecting "Lay Out in a Grid" from the menu. The final design with layout lines should resemble something similar to [[:Image:QtDesigner3-CompleteLayoutManagement.png|this image]].
+To finish the layout, we need to let the form look after the laid-out boxes. We put everything in a grid. This is done by right clicking the form and selecting <menuchoice>Lay Out in a Grid</menuchoice> from the menu. The final design with layout lines should resemble something similar to this image:
 ===Signals and Slots===

@@ Line 189: / Line 189: @@
 Adjust the size of the different widgets so they are nicely placed.
-Up to now, we have not named any of the widgets that are being placed in our program. It is useful to set an internal name for widgets so we can call them after in the program. Labels don't perform any action so they don't need to be named but other widgets do. It is the case now for our text boxes. We'll need to manipulate the data from the three input widgets (i.e. read the text) so we should give them a name. Names should be easily recognized later and they should make sense. The names are assigned via the name property on the top of the Property Editor. We name the top LineEdit ''nameBox'' and the second one ''mailBox''. We name the ComboBox ''commBox''. This will allow us to access the comments. So click on each <menuchoice>LineEdit</menuchoice> and then besides <menuchoice>Name</menuchoice> in the Property Editor write <code>nameBox</code> and code>mailBox</code>. Then click on the <menuchoice>ComboBox and name it <code>commBox</code>.
+[[Image:QtDesigner3-BeforeLayoutManagement.png|thumb|350px]] Up to now, we have not named any of the widgets that are being placed in our program. It is useful to set an internal name for widgets so we can call them after in the program. Labels don't perform any action so they don't need to be named but other widgets do. It is the case now for our text boxes. We'll need to manipulate the data from the three input widgets (i.e. read the text) so we should give them a name. Names should be easily recognized later and they should make sense. The names are assigned via the name property on the top of the Property Editor. We name the top LineEdit ''nameBox'' and the second one ''mailBox''. We name the ComboBox ''commBox''. This will allow us to access the comments. So click on each <menuchoice>LineEdit</menuchoice> and then besides <menuchoice>Name</menuchoice> in the Property Editor write <code>nameBox</code> and <code>mailBox</code>. Then click on the <menuchoice>ComboBox</menuchoice> and name it <code>commBox</code>.
-[[Image:QtDesigner3-BeforeLayoutManagement.png|right|thumb|350px]] We finish the graphical design by adding a label with ''Generated Signature'' as text. Below it, we put a TextEdit (<menuchoice>Tools -> Input -> TextEdit</menuchoice>) where the generated signature will be displayed. We name it <code>sigBox</code>. And then we add two PushButtons at the bottom ('Create!' and 'Cancel'). They don't need names but you can give them some if you want.
+We finish the graphical design by adding a label with ''Generated Signature'' as text. Below it, we put a TextEdit (<menuchoice>Tools -> Input -> TextEdit</menuchoice>) where the generated signature will be displayed. We name it <code>sigBox</code>. And then we add two PushButtons at the bottom ('Create!' and 'Cancel'). They don't need names but you can give them some if you want.
 Save your form. You can now have a quick preview by selecting the menu <menuchoice>Preview -> Preview Form</menuchoice>.  This is the form ''before'' layout management.

@@ Line 161: / Line 161: @@
 ===Adding Widgets===
-To start, we will insert the text at the top of the program window, which can be seen [[:Image:KDevelop3-NewFile-Widget.png|here]]. This text tells the user how to operate the program. This type of widget is called a ''Label'' and you can put one on your program like this:
+To start, we will insert the text at the top of the program window, which can be seen here:
-# Select the dialog in ToolBox called '''Common Widgets->TextLabel''', or from the menubar '''Tools->Display->TextLabel'''
+This text tells the user how to operate the program. This type of widget is called a ''Label'' and you can put one on your program like this:
 # The cursor will become a crosshair over the form. Draw a box for the label, just as you would in a paint program, and you will see that the label is created with some dummy text in it.
-# To change this text, double click on the label and type in the text, instead of ''TextLabel1''. The text you should type is ''This program will create an email signature for you. Just fill in the boxes and hit the Create! button.'' Select '''Align Center'' to have the text positioned nicely.  Refer to this [[:Image:QtDesigner3-TextEditDialog.png|screenshot]].
+# Select the dialog in ToolBox called <menuchoice>Common Widgets -> TextLabel</menuchoice>, or from the menubar <menuchoice>Tools -> Display -> TextLabel</menuchoice></translate>
-# Finally, resize the widget using the handles so it is the correct size and at the top of the box. Try to center the label by moving it with the mouse. This is just a temporary measure. Later on we will look at a more elegant layout management technique. You may refer to [[:Image:QtDesigner3-ResizingBox.png|this screenshot]].
+<translate>
 You follow pretty much the same procedure for embedding any type of widget that is supported by Qt Designer; select it, drag it, and finally, change its properties and size.
-An interesting concept in Qt Designer is that widgets can act as containers for other widgets. This will be demonstrated in our next task, which is to create the input fields inside the frame. You can see that in Picture 8 we have a bunch of labels and text boxes inside a frame. This frame is called a Group Box and acts as a container for the labels and text boxes inside it. Let's first create the frame by selecting the GroupBox in the '''Toolbox dialog->Containers''' or '''Tools->Containers->GroupBox''' from the menubar. You can drag the mouse to create the box just below the Label you put before. In the ''Property Editor'' you can change the title property to alter the text in the frame. Put ''Details'' in the title text field. You may notice a + symbol in this entry in the ''Property Editor''. This indicates that the property has subproperties that can also be changed.
+An interesting concept in Qt Designer is that widgets can act as containers for other widgets. This will be demonstrated in our next task, which is to create the input fields inside the frame. You can see that in Picture 8 we have a bunch of labels and text boxes inside a frame. This frame is called a Group Box and acts as a container for the labels and text boxes inside it. Let's first create the frame by selecting the GroupBox in the <menuchoice>Toolbox dialog -> Containers</menuchoice> or <menuchoice>Tools -> Containers -> GroupBox</menuchoice> from the menubar. You can drag the mouse to create the box just below the Label you created before. In the ''Property Editor'' you can change the title property to alter the text in the frame. Put <code>Details</code> in the title text field. You may notice a + symbol in this entry in the ''Property Editor''. This indicates that the property has subproperties that can also be changed.
-Once you have created the frame (i.e the GroupBox), create three more labels as before but when you draw them, draw them inside the GroupBox frame. You can then see in the Object Explorer box ('''Windows menu -> Views -> Object Explorer''') to the right that the labels have become children of the GroupBox frame. See [[:Image:QtDesigner3-EditingTheDialog.png|this image]].
+Once you have created the frame (i.e the GroupBox), create three more labels as before but when you draw them, draw them inside the GroupBox frame. You can then see in the Object Explorer box (<menuchoice>Windows menu -> Views -> Object Explorer</menuchoice>) to the right that the labels have become children of the GroupBox frame. See this image:
 Change the text of labels by double-clicking on it.
-Once you have done this you can then create the text boxes. They will allow the user to type in text like his(her) name and email address. We use the simplest type of text boxes: a widget called QLineEdit which allows the user to enter one line of text only. You have to create two QLineEdit widgets for the name and the email address. You choose the menu Tools then the entry Input then LineEdit and you draw it beside the 'Your Name' Label. Do the same below for the address.
+Once you have done this you can then create the text boxes. They will allow the user to type in text like his(her) name and email address. We use the simplest type of text boxes: a widget called QLineEdit which allows the user to enter one line of text only. You have to create two QLineEdit widgets for the name and the email address. You choose the menu <menuchoice>Tools -> Input -> LineEdit</menuchoice> and you draw it beside the 'Your Name' Label. Do the same below for the address.
-The witty comment will be selected by the user. We use a ComboBox which will present the user with three comments. Click on the ComboBox icon or select it via the Tools-> Input-> ComboBox menu. Draw it beside the Witty Comment label. Then double-click on it. You will be presented with a box into which you can add the contents of the combo box. Click on the 'New Item' button and type in your comment in the text box at the right. Then click again on 'New Item' for the second and third comments. Click on OK when you have finished.
+The witty comment will be selected by the user. We use a ComboBox which will present the user with three comments. Click on the ComboBox icon or select it via the <menuchoice>Tools -> Input-> ComboBox</menuchoice> menu. Draw it beside the Witty Comment label. Then double-click on it. You will be presented with a box into which you can add the contents of the combo box. Click on the <menuchoice>New Item</menuchoice> button and type in your comment in the text box at the right. Then click again on <menuchoice>New Item</menuchoice> for the second and third comments. Click on <menuchoice>OK</menuchoice> when you have finished.
 Adjust the size of the different widgets so they are nicely placed.
-Up to now, we have not named any of the widgets that are being placed in our program. It is useful to set an internal name for widgets so we can call them after in the program. Labels don't perform any action so they don't need to be named but other widgets do. It is the case now for our text boxes. We'll need to manipulate the data from the three input widgets (i.e. read the text) so we should give them a name. Names should be easily recognized later and they should make sense. The names are assigned via the name property on the top of the Property Editor. We name the top LineEdit nameBox and the second one mailBox. We name the ComboBox commBox. This will allow us to access the comments. So click on each LineEdit and then besides Name in the Property Editor write nameBox and mailBox. Then click on the ComboBox and name it commBox.
+Up to now, we have not named any of the widgets that are being placed in our program. It is useful to set an internal name for widgets so we can call them after in the program. Labels don't perform any action so they don't need to be named but other widgets do. It is the case now for our text boxes. We'll need to manipulate the data from the three input widgets (i.e. read the text) so we should give them a name. Names should be easily recognized later and they should make sense. The names are assigned via the name property on the top of the Property Editor. We name the top LineEdit ''nameBox'' and the second one ''mailBox''. We name the ComboBox ''commBox''. This will allow us to access the comments. So click on each <menuchoice>LineEdit</menuchoice> and then besides <menuchoice>Name</menuchoice> in the Property Editor write <code>nameBox</code> and code>mailBox</code>. Then click on the <menuchoice>ComboBox and name it <code>commBox</code>.
-We finish the graphical design by adding a label with 'Generated Signature' as text. Below it, we put a TextEdit ('''Tools->Input->TextEdit'''') where the generated signature will be displayed. We name it 'sigBox'. And then we add two PushButtons at the bottom ('Create!' and 'Cancel'). They don't need names but you can give them some if you want.
+[[Image:QtDesigner3-BeforeLayoutManagement.png|right|thumb|350px]] We finish the graphical design by adding a label with ''Generated Signature'' as text. Below it, we put a TextEdit (<menuchoice>Tools -> Input -> TextEdit</menuchoice>) where the generated signature will be displayed. We name it <code>sigBox</code>. And then we add two PushButtons at the bottom ('Create!' and 'Cancel'). They don't need names but you can give them some if you want.
-Save your form. You can now have a quick preview by selecting the menu '''Preview-> Preview Form'''.  [[:Image:QtDesigner3-BeforeLayoutManagement.png|This]] is the form ''before'' layout management.
+Save your form. You can now have a quick preview by selecting the menu <menuchoice>Preview -> Preview Form</menuchoice>.  This is the form ''before'' layout management.
 ===Getting Spaced Out===

@@ Line 133: / Line 133: @@
 The Qt Designer interface]] is essentially split into three areas.
-[[:Image:QtDesigner3-Interface.png|center|thumb|350px]]
+[[Image:QtDesigner3-Interface.png|center|thumb|350px]]
 On the left is the ''toolbox'', where you can select your widgets. On the right, several dialogs can be selected. I'll keep only the ''Property Editor'' dialog (I close the 2 others). Your widgets can be fine tuned to behave how you want them to. You can choose the size of the widget, its background color (palette), and so on. Between those 2 windows is the ''Form'', your program window, within which you will design your user interface.

@@ Line 5: / Line 5: @@
 ==Introduction==
 To get us started doing something useful with [http://www.trolltech.com/products/qt/features/designer Qt Designer], we are going to build a simple program that will show you the power of Qt Designer and [http://www.kdevelop.org/ KDevelop]. I hope that this will help you to create your first "real" KDE application.
@@ Line 12: / Line 13: @@
 ===How to Get Qt Designer===
 ====From your Distribution====
 Qt Designer is part of the qt-3.2.x package and above. If you have an older Qt on your system, you should get at least this version. At the time of writing, Qt latest version is 3.3.2.
@@ Line 18: / Line 21: @@
 To check if you have everything, do a:
+<code>locate qstring.h</code>
-<syntaxhighlight lang="text">locate qstring.h</syntaxhighlight>
 If you get something like ''/usr/lib/qt3/include/qstring.h'' then you can set your ''QTDIR'' variable to ''/usr/lib/qt3/''. In bash environment, this is done by typing:
-<syntaxhighlight lang="text">export QTDIR= /usr/lib/qt3</syntaxhighlight>
+<code>export QTDIR= /usr/lib/qt3</code>
 ====Tarball or Anonymous Subversion====
-For an explanation for how to use anonymous SVN, get the ''qt-copy'' and ''kde'' modules and compile them, please see a great documentation at [[Getting_Started/Sources/Using Subversion with KDE|Using Subversion with KDE]].
+You can download the tarball from the [http://www.trolltech.com/download/qt/x11.html Trolltech website], or get the ''qt-copy'' module from SVN. Please note that Qt for [http://www.kernel.org/ Linux] is [http://www.gnu.org/copyleft/gpl.html GPL].
-−
-You must then set the ''QTDIR'' environment variable. This should point to the directory into which you installed Qt. In bash, for example, you would type:
-<syntaxhighlight lang="text">export QTDIR= /usr/local/qt</syntaxhighlight>
+For an explanation for how to use anonymous SVN, get the ''qt-copy'' and ''kde'' modules and compile them, please see a great documentation at [[Special:myLanguage/Getting_Started/Sources/Using Subversion with KDE|Using Subversion with KDE]].
 provided that ''/usr/local/qt'' is the directory into which you installed Qt. Please read the INSTALL file for more details.

@@ Line 1: / Line 1: @@
 {{improve}}
 {{KDE3}}
@@ Line 365: / Line 367: @@
 </syntaxhighlight>
 to be sure you have the latest version.

@@ Line 17: / Line 17: @@
 To check if you have everything, do a:
-<syntaxhighlight lang="text">locate qstring.h</code>
+<syntaxhighlight lang="text">locate qstring.h</syntaxhighlight>
 If you get something like ''/usr/lib/qt3/include/qstring.h'' then you can set your ''QTDIR'' variable to ''/usr/lib/qt3/''. In bash environment, this is done by typing:
-<syntaxhighlight lang="text">export QTDIR= /usr/lib/qt3</code>
+<syntaxhighlight lang="text">export QTDIR= /usr/lib/qt3</syntaxhighlight>
 ====Tarball or Anonymous Subversion====
@@ Line 30: / Line 30: @@
 You must then set the ''QTDIR'' environment variable. This should point to the directory into which you installed Qt. In bash, for example, you would type:
-<syntaxhighlight lang="text">export QTDIR= /usr/local/qt</code>
+<syntaxhighlight lang="text">export QTDIR= /usr/local/qt</syntaxhighlight>
 provided that ''/usr/local/qt'' is the directory into which you installed Qt. Please read the INSTALL file for more details.
@@ Line 38: / Line 38: @@
 <syntaxhighlight lang="text">./configure -system-zlib -qt-gif -system-libpng -system-libjpeg \
 -plugin-imgfmt-mng -thread -no-exceptions -debug -fast
-make</code>
+make</syntaxhighlight>
 The command ''make install'' is not needed.
 Qt Designer is located in the ''bin'' directory of your Qt installation directory. You can run it by typing:
-<syntaxhighlight lang="text">/usr/local/qt/bin/designer</code>
+<syntaxhighlight lang="text">/usr/local/qt/bin/designer</syntaxhighlight>
 in a console.
@@ Line 60: / Line 60: @@
 <syntaxhighlight lang="text">export PATH=$QTDIR/bin:$KDEDIR/bin:$PATH
-export LD_LIBRARY_PATH=$QTDIR/lib:$LD_LIBRARY_PATH</code>
+export LD_LIBRARY_PATH=$QTDIR/lib:$LD_LIBRARY_PATH</syntaxhighlight>
 If you have any problem getting KDevelop running, please refer to the [http://www.kdevelop.org/phorum5/ KDevelop Forum] to find the answer to your problem.
@@ Line 86: / Line 86: @@
 <syntaxhighlight lang="text">" Good - your configure finished. Start make now
+*
-* *** Success ***</code>
+* *** Success ***</syntaxhighlight>
 so you can run ''make'' with '''Build -> Build Project''' (or using the F8 shortcut). Then '''Build -> Install'''. Then '''Build -> Execute program''' (or F9). The result is shown [[:Image:KDevelop-SigCreate.png|here]].
@@ Line 204: / Line 204: @@
 app.setMainWidget( mainWin );
 mainWin->show();
-</code>
+</syntaxhighlight>
 ===Implementing the Slot===
@@ Line 211: / Line 211: @@
 <syntaxhighlight lang="text">
 void SigCreate::slotCreateSig()
-{}</code>
+{}</syntaxhighlight>
 to implement the slot
@@ Line 219: / Line 219: @@
   	sigBox->append(mailBox->text());
   	sigBox->append(commBox->currentText());
-</code>
+</syntaxhighlight>
 and also the corresponding headers of course:
 <syntaxhighlight lang="text">
@@ Line 225: / Line 225: @@
   #include <qcombobox.h>
   #include <qmultilineedit.h>
-</code>
+</syntaxhighlight>
 Run ''Build -> Run automake & friends'', ''Build-> Run Configure'', ''Build -> Build Project'', ''Build -> Install'' (or ''Build->Install as root user''), ''Build -> Execute Program''. That's it! The program is working!
@@ Line 259: / Line 259: @@
   $ cp src/gettext src/xgettext ~/bin # copy gettext and xgettext into your HOME/bin directory
   $ export PATH=~/bin:$PATH
-</code>
+</syntaxhighlight>
 === Prepare the Translations ===
@@ Line 267: / Line 267: @@
 <syntaxhighlight lang="text">
   $ cd /path/to/myproject
-</code>
+</syntaxhighlight>
 Set KDEDIR to match your kde installation - on my Mandrake it is /usr This path can also be found by doing "kde-config --prefix"
 <syntaxhighlight lang="text">
   $ export KDEDIR=`kde-config --prefix` # or export KDEDIR=/usr
-</code>
+</syntaxhighlight>
 Then create the translations files :
 <syntaxhighlight lang="text">
   $ make -f admin/Makefile.common package-messages
-</code>
+</syntaxhighlight>
 === Make the Translations ===
@@ Line 288: / Line 288: @@
   $ make package-messages
   $ sudo make install
-</code>
+</syntaxhighlight>
 ==General Tips==
@@ Line 310: / Line 310: @@
 void toDesktop(int);
 void windowAdded(WId);
-</code>
+</syntaxhighlight>
 Code indentation can be whatever you like as long as the code is visible for other developers. Always keep in mind that other people will have a look in your code and try to make it easy to read.
@@ Line 328: / Line 328: @@
      $ cd kdenonbeta
      $ cvs co admin  (or ln -s ../kde-common/admin .admin)
-</code>
+</syntaxhighlight>
 You copy your project main dir with everything in kdenonbeta and then, in your project main dir, you issue a:
 <syntaxhighlight lang="text">
      $ make disclean
-</code>
+</syntaxhighlight>
 All the .o files must be gone. You can also remove by hand all Makefile, Makefile.in (not Makefile.am) and all kdevelop related files. Remove the admin, autom4te.cache, debug, doc, po and templates folders. You must just keep some files and the src subdir. Then, you cd .. to go back in kdenonbeta and you type:
 <syntaxhighlight lang="text">
@@ Line 340: / Line 340: @@
      $ make
      $ su -c 'make install'
-</code>
+</syntaxhighlight>
 All these steps must go well. If there are errors, you should be able to correct them by carefully reading the error message. If you are really stuck, please go to IRC and ask on #kde or #kde-devel, someone will help you.
@@ Line 352: / Line 352: @@
      $ cvs add your_project_name/src/*
      $ cvs commit
-</code>
+</syntaxhighlight>
 You get the window (vi editor as default) where you can log your message. It's a good practice to note what your commit is about. In your case, you will say (type i first if you are in vi to get in edit mode):
@@ Line 363: / Line 363: @@
 <syntaxhighlight lang="text">
      $ cvs up
-</code>
+</syntaxhighlight>
 to be sure you have the latest version.