1
0
mirror of https://github.com/golang/go synced 2024-11-24 20:00:10 -07:00

- added missing formatters in templates

- replaced deprecated use of </font> with </span> tag
- added html escaping to godoc formatters where missing
- enabled text format for package documentation

R=rsc
http://go/go-review/1017001
This commit is contained in:
Robert Griesemer 2009-10-28 16:19:09 -07:00
parent 32e979c0de
commit c54cb4cb4d
4 changed files with 20 additions and 10 deletions

View File

@ -11,11 +11,11 @@
{.section Filenames} {.section Filenames}
<p> <p>
<h4>Package files</h4> <h4>Package files</h4>
<font size=-1> <span style="font-size:90%">
{.repeated section @} {.repeated section @}
<a href="/{FilePath|html}/{@|html}">{@|html}</a> <a href="/{FilePath|html}/{@|html}">{@|html}</a>
{.end} {.end}
</font> </span>
</p> </p>
{.end} {.end}
{.section Consts} {.section Consts}

View File

@ -6,5 +6,5 @@
<pre> <pre>
{.repeated section list} {.repeated section list}
{src}{.section msg}<b><font color=red>«{msg|html}»</font></b>{.end}{.end} {src|html}{.section msg}<b><span class="alert">«{msg|html}»</span></b>{.end}{.end}
</pre> </pre>

View File

@ -36,7 +36,7 @@
<p> <p>
Legend: Legend:
{.repeated section Legend} {.repeated section Legend}
<a class="{@}">{@}</a> <a class="{@|html}">{@|html}</a>
{.end} {.end}
</p> </p>
{.repeated section @} {.repeated section @}

View File

@ -133,7 +133,7 @@ func init() {
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// Support // Predicates and small utility functions
func isGoFile(dir *os.Dir) bool { func isGoFile(dir *os.Dir) bool {
return dir.IsRegular() && return dir.IsRegular() &&
@ -153,6 +153,13 @@ func isPkgDir(dir *os.Dir) bool {
} }
func htmlEscape(s string) string {
var buf bytes.Buffer;
template.HtmlEscape(&buf, strings.Bytes(s));
return buf.String();
}
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// Parsing // Parsing
@ -322,7 +329,7 @@ func htmlFmt(w io.Writer, x interface{}, format string) {
func htmlCommentFmt(w io.Writer, x interface{}, format string) { func htmlCommentFmt(w io.Writer, x interface{}, format string) {
var buf bytes.Buffer; var buf bytes.Buffer;
writeAny(&buf, x, false); writeAny(&buf, x, false);
doc.ToHtml(w, buf.Bytes()); doc.ToHtml(w, buf.Bytes()); // does html-escaping
} }
@ -342,12 +349,13 @@ func linkFmt(w io.Writer, x interface{}, format string) {
if pos.IsValid() { if pos.IsValid() {
// line id's in html-printed source are of the // line id's in html-printed source are of the
// form "L%d" where %d stands for the line number // form "L%d" where %d stands for the line number
fmt.Fprintf(w, "/%s#L%d", pos.Filename, pos.Line); fmt.Fprintf(w, "/%s#L%d", htmlEscape(pos.Filename), pos.Line);
} }
} }
} }
// The strings in infoClasses must be properly html-escaped.
var infoClasses = [nKinds]string{ var infoClasses = [nKinds]string{
"package", // PackageClause "package", // PackageClause
"import", // ImportDecl "import", // ImportDecl
@ -362,7 +370,7 @@ var infoClasses = [nKinds]string{
// Template formatter for "infoClass" format. // Template formatter for "infoClass" format.
func infoClassFmt(w io.Writer, x interface{}, format string) { func infoClassFmt(w io.Writer, x interface{}, format string) {
fmt.Fprintf(w, infoClasses[x.(SpotInfo).Kind()]); fmt.Fprintf(w, infoClasses[x.(SpotInfo).Kind()]); // no html escaping needed
} }
@ -384,9 +392,11 @@ func infoSnippetFmt(w io.Writer, x interface{}, format string) {
text := `<span class="alert">no snippet text available</span>`; text := `<span class="alert">no snippet text available</span>`;
if info.IsIndex() { if info.IsIndex() {
index, _ := searchIndex.get(); index, _ := searchIndex.get();
// no escaping of snippet text needed;
// snippet text is escaped when generated
text = index.(*Index).Snippet(info.Lori()).Text; text = index.(*Index).Snippet(info.Lori()).Text;
} }
fmt.Fprintf(w, "%s", text); fmt.Fprint(w, text);
} }
@ -667,7 +677,7 @@ func servePkg(c *http.Conn, r *http.Request) {
info := getPageInfo(path); info := getPageInfo(path);
var buf bytes.Buffer; var buf bytes.Buffer;
if false { // TODO req.Params["format"] == "text" if r.FormValue("f") == "text" {
if err := packageText.Execute(info, &buf); err != nil { if err := packageText.Execute(info, &buf); err != nil {
log.Stderrf("packageText.Execute: %s", err); log.Stderrf("packageText.Execute: %s", err);
} }