View Issue Details

IDProjectCategoryView StatusLast Update
0000758unrealdocumentationpublic2003-11-20 19:43
ReporterAngryWolf Assigned Tosyzop  
PrioritynormalSeveritytextReproducibilityN/A
Status closedResolutionfixed 
Product Version3.2-beta14 
Summary0000758: Additional suggestions & corrections for unreal32docs.html
DescriptionI describe some suggestions and corrections below. Some of them are tiny, but it would increase readibility.

1. Date :)

=================
Last doc update: 2002-02-28
=================

2003 should be better.

2. Table of contents

=================
-- 3.5.#feature_aliases

(...)
---4.3.#adminblock

---4.4. #classblock

=================

Spaces are missing and/or located in wrong place.

3. Subtitles


=================
1.0 Introduction & Notes
4.1 Configuration File Explained
=================

Missing space or '-'.

4. Introduction

=================
This document was written for exclusively for use with UnrealIRCd
...is strictly prohibited with out the written permission of...
=================

"for" twice.
"with out" written apart.

5. Notes on upgrading/mixing 3.1.x -> 3.2.x

=================
It's best not to mix/link 3.1.x with 3.2.x
=================

"the best"?

6. Using bold/italics/colors or something.

Sometimes it helps readability if you place some keywords inside . A clear example is the following:

=================
<block-name> is the type of block, such as me, or admin.
=================

7. Using
, tabulator characters and/or <code> for directive examples

=================

Syntax: me { name <name-of-server>; info <server-description>; numeric <server-numeric>; } ;

================= This is less readable unless you use something like this (for example):

Syntax:

me {
    name <name-of-server>;
    info <server-description>;
    numeric <server-numeric>;
};


As you do it at section 4.10 - LoadModule Directive.
Attached Files
bugreport.txt (1,727 bytes)
3rd party modules

Activities

AngryWolf

2003-02-28 12:07

reporter   ~0001716

Oh, hell, sorry, I forgot that HTML code accepted in text entries... I've uploaded bugreport.txt which contains only plain text. Sorry again.

syzop

2003-02-28 14:28

administrator   ~0001717

Ok..

[nr's from text file, date is 0]
0: should be fixed [<b15]
1, 2: layout [maybe <15.. not so important]
3: should be fixed [<b15]
4: you are incorrect
5, 6: layout improvements requests [>b15].

AngryWolf

2003-02-28 16:19

reporter   ~0001718

Roger, thanks.

4: My fault, sorry.

AngryWolf

2003-03-10 19:49

reporter   ~0001858

I can see codemastr fixed suggestion number 1

Already fixed (or wasn't a bug): 0, 1, 3, 4
waiting for 2, 5, 6.

codemastr

2003-03-11 00:57

reporter   ~0001872

I was bored at school today and I made a lot of corrections, once I finish all the corrections I intend to make I'll commit it. But most of what you said has already been addressed:

2.) Done
4.) Done, technically it wasn't wrong, but it was worded kinda oddly.
7.) Done

AngryWolf

2003-03-11 05:25

reporter   ~0001873

Last edited: 2003-03-11 05:25

That's good! :) But you aren't using the numbers from the text file.

Now the remaining points are "2. Subtitles" and "5. Using bold/italics/colors or something."

edited on: 03-11 05:25

AngryWolf

2003-03-11 19:27

reporter   ~0001877

Last edited: 2003-03-11 19:30

Sorry, but I must continue bugreport 0000777 (but now without my stupid C knowledge, hehe): oh, do you think it's not a bug?

From unreal32docs.html:
------------------
set::prefix-quit <text-to-prefix-quit>;
Sets the text that will be used to prefix a quit message. If this value is set to 0 then the standard "Quit:" is used.
------------------

If it isn't a bug then there's a mistake in the documentation... no?

edited on: 03-11 19:30

AngryWolf

2003-03-11 19:31

reporter   ~0001878

And no mention about if I set the value to "no" then no prefix is used.

syzop

2003-05-08 02:21

administrator   ~0002706

* that prefix-quit thing you pointed out won't be fixed unless someone is bored so don't ask again.
* codemastr did some layout improvements (and I did some minor few too), the point is clear, if we are bored we'll improve it even more.

Issue History

Date Modified Username Field Change
2003-05-08 02:21 syzop Status new => resolved
2003-05-08 02:21 syzop Resolution open => fixed
2003-05-08 02:21 syzop Assigned To => syzop
2003-05-08 02:21 syzop Note Added: 0002706
2003-11-20 19:43 syzop Status resolved => closed