PennMUSH Community

root/1.8.3/trunk/game/txt/hlp/pennpueb.hlp

Revision 654, 4.0 kB (checked in by penndev, 1 year ago)

PennMUSH 1.8.3p0 release candidate.

Line 
1 & PUEBLO
2 & PUEBLO()
3 Pueblo is a client made by Chaco (a now defunct company).
4 It attempts to mix HTML with MUSH, and does a decent job at it.
5 There are other clients (notably MUSHclient) that also offer Pueblo
6 features.  If compiled into the MUSH, PennMUSH offers support for
7 the enhanced features of Pueblo.
8
9 PennMUSH will automatically detect a Pueblo client (rather, the
10 client will announce itself and PennMUSH will detect that), and
11 set up that connection for Pueblo use.
12
13 The PUEBLO() function returns 1 for players connected with Pueblo,
14 0 for players with other clients, and #-1 NOT CONNECTED for
15 players who aren't connected. It uses the most recently active
16 connection if a player is multiply logged in.
17
18 For more information, see 'Pueblo features', 'HTML' and
19 'HTML Functions'.
20
21 & PUEBLO FEATURES
22 PennMUSH makes the following enhancements visible to Pueblo users, if
23 Pueblo support has been enabled in the server (check @config):
24
25 - Object/Room names are highlighted
26 - Support for VRML graphics
27 - Unordered list for contents and transparent exits
28 - Contents and links have links (Click an exit to walk through it)
29 - Object lists (like the ones found in 'examine') have links
30 - Conversion of ANSI sequences to <FONT> tags.
31
32 See also: 'HTML', 'HTML Functions' and '@VRML_URL' for more help.
33
34 & @VRML_URL
35 & VRML
36 @VRML_URL Object=<URL>
37
38 This provides an object (usually a room) with a VRML world. When a
39 Pueblo-user enters this object, the VRML World listed in @VRML_URL
40 will be loaded.
41
42 Example:
43 @VRML_URL here=http://www.pennmush.org/pennmush.vrml
44
45 To learn about the VRML Format, have a look at the Pueblo Help, which
46 mentions several good sites for learning.
47
48 See also: 'HTML'.
49
50 & HTML
51 Hyper Text Markup Language (http://www.w3.org)
52
53 The only HTML implementation supported by the MUSH is the one
54 supported by Pueblo (See 'Pueblo'). To utilize HTML, use
55 one of the MUSH HTML Functions. (See 'HTML Functions').
56
57 HTML tags are stripped when sent to non-HTML capable players.
58
59 See also: 'HTML Functions'.
60 & HTML FUNCTIONS
61 HTML Functions are used to output HTML tags to HTML capable
62 users. These tags will be stripped by the system for anything
63 non-HTML related. These functions will not be available if
64 the server is compiled without Pueblo support (check @config).
65
66 html()
67 tag()
68 endtag()
69 tagwrap()
70
71 Examples:
72   [html(A HREF="http://www.pennmush.org")]PennMUSH[html(/A)]
73   [tag(A,HREF="http://www.pennmush.org")]PennMUSH[endtag(A)]
74   [tagwrap(A,HREF="http://www.pennmush.org",PennMUSH)]
75 Each of these produces the HTML output:
76   <A HREF="http://www.pennmush.org">PennMUSH</A>
77
78 Mortals are restricted in the tags they may use. Most standard HTML
79 tags are ok; protocol-specific tags like SEND and XCH_CMD can only be
80 sent by Wizards. In addition, the html() function is Wizard-only.
81 & HTML()
82 Function: html(<string>)
83
84 This wizard-only function will output string as a HTML Tag.
85
86 Example:
87   think [html(B)]
88
89 Will output (in HTML):
90   <B>
91
92 Non-wizards should see the tag(), endtag(), and tagwrap() functions.
93 & TAG()
94 Function: tag(<name>,[param1[,param2...]])
95
96 This will output the tag 'name' with values from it's parameters.
97
98 Example:
99  [tag(IMG,SRC=http://www.pennmush.org/someimage.jpg,ALIGN=LEFT,WIDTH=300)]
100
101 Will output (in HTML):
102  <IMG SRC=http://www.pennmush.org/someimage.jpg ALIGN=LEFT WIDTH=300>
103
104 & ENDTAG()
105 Function: endtag(<name>)
106
107 This will output an end tag 'name'.
108
109 Example:
110  [endtag(IMG)]
111
112 Will output (in HTML):
113  </IMG>
114
115 & TAGWRAP()
116 Function: tagwrap(<tag>[,<parameters>],<string>)
117
118 This will output 'tag' with parameters, followed by 'string', and then
119 a closing tag for 'tag'.
120
121 Example:
122  [tagwrap(A,HREF=http://lists.pennmush.org,PennMUSH Lists)]
123 Will output (in HTML):
124  <A HREF=http://lists.pennmush.org>PennMUSH Lists</A>
125
126 A particularly important use of this function is tagwrap(PRE,<string>).
127 Because Pueblo works like an html browser, spaces and tabs are compressed
128 to a single space. If you have code (a +who function, for example) that
129 relies on exact spacing, surround its output with a tagwrap(PRE,...)
130 so that Pueblo will render it as "preformatted" text.
131
Note: See TracBrowser for help on using the browser.