Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 36751 - Review of coding style in vi-guide.xml
Summary: Review of coding style in vi-guide.xml
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Vi HOWTO (show other bugs)
Hardware: All All
: High normal (vote)
Assignee: Docs Team
URL: http://www.gentoo.org/doc/en/vi-guide...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-12-29 12:13 UTC by Arne Mejlholm (RETIRED)
Modified: 2003-12-30 07:23 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments
The corrected file (vi-guide.xml,24.44 KB, text/plain)
2003-12-29 12:14 UTC, Arne Mejlholm (RETIRED)
Details
Second corrected vi-guide.xml (vi-guide.xml,24.40 KB, text/xml)
2003-12-30 03:44 UTC, Sven Vermeulen (RETIRED)
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Arne Mejlholm (RETIRED) gentoo-dev 2003-12-29 12:13:13 UTC
The coding style of vi-guide.xml looked terrible...

I also noticed some other things, which I'll point out in the following:

--- Line 36 in the old document:
 <section>
 <title>About the guide</title>
-<title>Learning vi -- accelerated</title> <-- removed
 <body>

Can't have two titles for one section.

--- Line 98 in the old document:
<pre> --> <pre caption="Loading a file into vi">


--- Line 204 in the old document:
<title>quiting</title> --> <title>Quitting</title>


--- Line 320 in the old document:
 <chapter>
 <title>Insert mode</title>
 <section>
-<title>Insert mode</title> <-- removed

--- Line 377 in the old document:
 <chapter>
 <title>Compound Commands</title>
 <section>
-<title>Compound commands</title> <-- removed
 <body>

It seems strange to have the same title both as the chapter and section, so for now I have removed them. They should perhaps have other titles instead.

--- Line 430 in the old document:
-</body>
-</section>
-<section>
-<title></title>
-<body>

This last section seemed odd as the section above was only one paragraph.

So to conclude, the issue is mostly about coding style :-)
Comment 1 Arne Mejlholm (RETIRED) gentoo-dev 2003-12-29 12:14:35 UTC
Created attachment 22812 [details]
The corrected file
Comment 2 Sven Vermeulen (RETIRED) gentoo-dev 2003-12-30 03:44:27 UTC
Created attachment 22839 [details]
Second corrected vi-guide.xml 

This one has removed <i>'s when they aren't allowed (this is no content change
:) and removed the blank lines between </section> and <section>. 

I've also bumped the version number (because of the caption changes) and date.
Whoever commits, please reference #36751 (yes, this bug) so that translators
can see what else changed.

And in the future, please do separate patches for content changes and coding
style. For instance first do coding style, commit (you don't need approval to
commit coding style updates) and then content changes (in this case you don't
need review either 'cause the changes aren't technical/intrusive).
Comment 3 Arne Mejlholm (RETIRED) gentoo-dev 2003-12-30 07:23:32 UTC
Thanks :)

I have committed the second corrected vi-guide.