Subversion Repositories wimsdev

Rev

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