Subversion Repositories wimsdev

Rev

Rev 4051 | Rev 5920 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
32 reyssat 1
<p>
2
The following is the things you should check.
3
<ol>
4
 <li>Find a wims site, verify the
1091 bpr 5
  <a href="html/policy.html">site policy</a> or contact the site manager,
32 reyssat 6
  to see whether they are interested in carrying your page. <p>
7
  If the site has a test server, you may also ask the site manager to give you
8
  a test account. This will allow you to submit and test your draft pages
9
  repeatedly, at a very high frequency.
10
  <p>
11
  The home site wims.unice.fr contains such a test server which welcomes all
12
  people desirous of writing mathematical pages. But connection
13
  might be slow for non-European users.
4051 bpr 14
  </li><li>Connect to to the test server (from your browser), submit your (existing)
32 reyssat 15
  html file into it, and make a http request for the page, to see thether it
16
  is there.
17
  Then add some mathematical symbols, wims variables and commands into your
18
  file, resubmit it, and reload your page to see whether it works. If you
19
  make an error, wims server will
20
  directly send error messages to your browser. Continue this way until everything
21
  seems OK for you.
22
  <p>
23
  You have only to submit your html file which requires wims services. Graphics
24
  files, may stay where they were, on your original site. But you
25
  should make sure that the file you submitted to wims site contains only
26
  links to absolute addresses.  
4051 bpr 27
  </li><li> Please
32 reyssat 28
  read the corresponding chapters of the technical reference of this document
29
  to see how to add variables and commands into your file. <p>
30
  Briefly, a variable is a word preceeded by the dollar sign $emph $$$emphend.
31
  You may use predefined variables (see
1091 bpr 32
  $(ref1)varspecial$(ref2)varspecial">$title_varspecial</a>), or define your
32 reyssat 33
  own (by the command
1091 bpr 34
  $(ref1)cmdlist_let_&+cmd_choose=all$(ref2)cmdlist_let_">!set</a>).
32 reyssat 35
  <p>
36
  And a wims command is a word preceeded by the character $emph !$emphend, <b>
37
  when it appears at the beginning of a line</b>. The list of commands as
38
  well as their syntax can be found
1091 bpr 39
  $(ref1)cmdlist$(ref2)cmdlist">here</a> in this document.
4051 bpr 40
  </li><li>If you want your page to be visible by the (future) wims
32 reyssat 41
  search engine, please copy a template file
1091 bpr 42
  (<a href="modules/light/template.en.phtml">English</a> or
43
  <a href="modules/light/template.fr.phtml">French</a> version), modify the header
32 reyssat 44
  according to your case, and put in the body of your html content.
4051 bpr 45
  </li><li>You can also copy (the source of) an existing phtml file, study its
32 reyssat 46
  structure, modify it to suit you (if the copyright policy of that file
47
  allows you to do so). Please browse
1091 bpr 48
  <a href="modules/">the modules directory</a> which contains sources of all the
32 reyssat 49
  modules (as well as light phtml files).
4051 bpr 50
  </li><li>When you think that your phtml page is ready, send a mail to the site manager,
32 reyssat 51
  asking him to transfer your page from the test server to the public wims server.
4051 bpr 52
  </li><li>Once your page appears on the public site, you may put links from anywhere
32 reyssat 53
  pointing to it, and/or submit its address to search engines.
4051 bpr 54
  </li>
32 reyssat 55
 
56
</ol>
57
 
5766 bpr 58
<p><hr/></p>
32 reyssat 59
<center><h3>Important notes</h3></center>
60
<p>When writing a phtml file, please take care of the following.
61
<ol>
62
 <li>You may adapt any html file composed by any html composer to a phtml
63
  file. But once your file contains any wims commands, you should no longuer
64
  use html composers to modify it. Because WIMS only recognizes commands at
65
  the beginning of a line, while most html composers will reformat the lines
66
  of your file. Use an ordinary text editor instead.
4051 bpr 67
  </li><li>If your file originally contains the dollar sign $emph$$$emphend other
32 reyssat 68
  than as a wims variable introducer, double them. Otherwise your dollar sign
69
  will probably disappear in the visitors' browsers.
4051 bpr 70
  </li><li>Make sure that no line starts with $emph !$emphend or $emph:$emphend,
32 reyssat 71
  other than for wims purposes.
4051 bpr 72
  </li>
32 reyssat 73
</ol>
5766 bpr 74
<hr/>
32 reyssat 75
I have yet to find time to write a detailed tutorial for how to use each
76
feature provided by wims server. If you have a question, please
77
!mailurl xiao@unice.fr write me
78
 or check the
1091 bpr 79
<a href="http://www.listes.cri74.org/wws/info/wims">WIMS mailing list</a>.
32 reyssat 80