I think I found a bug in wiki > Help...

Forum for discussion about the documentation project.
maddogg6
Posts: 824
Joined: Dec 07, 2005 22:58
Contact:

I think I found a bug in wiki > Help...

Postby maddogg6 » Jan 10, 2008 16:42

I notice that '?' shows up in the INDEX (index tab) (and links to) for the 'Operator &= (Concatenate And Assign)' page in the help file (I think I have most recent... Dec 2007)
Is the same in older ones too...

That, if correct, makes absolutely no sense to me - I would expect it to show the PRINT page instead.
Is this a known 'bug' in converting wiki

I found this looking for what '!' does (still not found in help file with 'search')
Used here:
http://www.freebasic.net/forum/viewtopi ... highlight=
In Joshy's example of a expression eval lib he shared.
(edit: Im not sure if its used only in that lib or if its an FB thing..??
simple testing verified its an FB thing, bt I dont find it in the help file)
counting_pine
Site Admin
Posts: 6219
Joined: Jul 05, 2005 17:32
Location: Manchester, Lancs

Postby counting_pine » Jan 10, 2008 20:31

"!" is a string prefix that allows escape codes.
/wiki/ProPgLiterals

It's kind of difficult to document/look up symbol characters. Perhaps what we need is one page listing all the uses for different characters.

I've brainstormed a list here. I don't know if it's too extensive, or if it's missing any obvious ones, or both:

Code: Select all

+ String/number operator: Concatenation
  Number operator: Numeric add operation
  3.1e+10: literal positive exponent indicator

- Unary number operator - negation
  Binary number operator: Numeric subtract operation
  3.1e-10: literal negative exponent indicator

* Unary pointer operator: dereference
  Binary number operator: Multiply operation
  Fixed string length specifier

\ Number operator: integer division

/ Number operator: floating-point division

^ Number Operator: power operation

! String literal prefix: enable Escape codes
  Identifier suffix: Single type specifier

$ Prefix: String literal modifier - disable Escape codes
  Identifier suffix: String type specifier

@ Unary identifier operator: Address

& Operator: Concatenation
  Identifier suffix: Long type specifier
 
+= -= *= /= \= ^= &= : "lhs op= rhs": Operate and assign (lhs = lhs op rhs)

% Identifier suffix: Integer type specifier

? Shortcut for Print

= "identifier = expr" statement: assignment/initialisation operator
  "lhs = rhs" expression: equality relation
  "dim/var identifier => expr": initialisation operator

< > "lhs > rhs", "lhs < rhs":  greater/less than relation
    "lhs <= rhs", "lhs >= rhs": greater/less or equal relation
    "lhs <> rhs": inequality relation

    type<udt>(a, b, c): type builder

'  comment specifier
'$ deprecated preprocessor command specifier
/' '/: multiline comment

#  beginning of line: preprocessor command specifier
   numeric prefix: file handle specifier (necessary in Print # and Get/Put #, optional elsewhere)
   Preprocessor: "#p" macro parameter stringize
## Preprocessor: "a##b" macro parameter/token name concatenation

_ Line continuation character

: Statement separator
  "elt : SIZE as integer": bitfield specifier

.  "udt.element": member access
   "3.14": Numeric literal decimal point

... Procedure variable argument indicator

-> "udtptr->element": dereference, member access

{} a(1 to 10) => {expr, expr, ...}: array literal assignment
[] ptr[idx] Pointer index
   stringvar[idx] String index
() arr(d1, d2, ...): Array index
   (expr) expression container
   procedure/type-builder argument container

, Argument separator (procedure calls, type building, variable declaring, ...)
  "Print expr1, expr2, expr3," : Print expression separator with column alignment
; "Print expr1; expr2; expr3;" : Print expression separator
elsairon
Posts: 207
Joined: Jul 02, 2005 14:51

Postby elsairon » Jan 10, 2008 22:15

Here is a link to the current CatPg for Operators.

http://www.freebasic.net/wiki/wikka.php?wakka=CatPgOperators

counting_pine wrote:It's kind of difficult to document/look up symbol characters. Perhaps what we need is one page listing all the uses for different characters.


I think an operator symbol list could be made on a new page, or added to the current one (I prefer this), so people could look up operators by symbol as well as function.

We might need sub-pages for some operators if they have many uses.

Preferences/thoughts anyone?
maddogg6
Posts: 824
Joined: Dec 07, 2005 22:58
Contact:

Postby maddogg6 » Jan 12, 2008 0:15

elsairon wrote:Here is a link to the current CatPg for Operators.

http://www.freebasic.net/wiki/wikka.php?wakka=CatPgOperators

counting_pine wrote:It's kind of difficult to document/look up symbol characters. Perhaps what we need is one page listing all the uses for different characters.


I think an operator symbol list could be made on a new page, or added to the current one (I prefer this), so people could look up operators by symbol as well as function.

We might need sub-pages for some operators if they have many uses.

Preferences/thoughts anyone?


I think its a good idea to have some sort of 'master index' of all 'operators' in one chart/table in the wiki / help.. so if *anything* gets referred to as 'an operator' could be found in 1 index somewhere.

Return to “Documentation”

Who is online

Users browsing this forum: No registered users and 4 guests