[100548] branches/new-help-system/base/doc

Fri Dec 14 19:51:18 PST 2012

Revision: 100548
          https://trac.macports.org/changeset/100548
Author:   raimue at macports.org
Date:     2012-12-14 19:51:18 -0800 (Fri, 14 Dec 2012)
Log Message:
-----------
doc:
Add a portundocumented(7) man page as a last resort for all undocumented topics

Modified Paths:
--------------
    branches/new-help-system/base/doc/Makefile
    branches/new-help-system/base/doc/asciidoc.conf

Added Paths:
-----------
    branches/new-help-system/base/doc/portundocumented.7
    branches/new-help-system/base/doc/portundocumented.7.txt

Modified: branches/new-help-system/base/doc/Makefile
===================================================================

--- branches/new-help-system/base/doc/Makefile	2012-12-15 02:48:16 UTC (rev 100547)
+++ branches/new-help-system/base/doc/Makefile	2012-12-15 03:51:18 UTC (rev 100548)
@@ -26,7 +26,7 @@
 		port-patch.1 \
 		port-uninstall.1
 MAN5=		macports.conf.5
-MAN7=		portfile.7 portstyle.7 porthier.7 portgroup.7
+MAN7=		portfile.7 portstyle.7 porthier.7 portgroup.7 portundocumented.7
 MAN=		${MAN1} ${MAN5} ${MAN7}
 
 # Filter man pages with existing source files

Modified: branches/new-help-system/base/doc/asciidoc.conf
===================================================================
--- branches/new-help-system/base/doc/asciidoc.conf	2012-12-15 02:48:16 UTC (rev 100547)
+++ branches/new-help-system/base/doc/asciidoc.conf	2012-12-15 03:51:18 UTC (rev 100548)
@@ -3,6 +3,7 @@
 #manversion is in the Makefile
 manmanual=MacPorts Manual
 guideurl=http://guide.macports.org/
+wikiurl=https://trac.macports.org/wiki/
 
 ## man: macro
 #
@@ -16,6 +17,7 @@
 [macros]
 (?su)[\\]?(?P<name>man):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
 (?su)[\\]?(?P<name>guide):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
+(?su)[\\]?(?P<name>wiki):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
 
 # man: and guide: for docbook
 ifdef::backend-docbook[]
@@ -25,6 +27,8 @@
 </citerefentry>
 [guide-inlinemacro]
 <ulink url="{guideurl}#{target}">{0={guideurl}{target}}</ulink>
+[wiki-inlinemacro]
+<ulink url="{wikiurl}{target}">{0={target}}</ulink>
 endif::backend-docbook[]
 
 # man: and guide: for xhtml11
@@ -33,6 +37,8 @@
 <a href="{target}{0?.{0}}.html">{target}{0?({0})}</a>
 [guide-inlinemacro]
 <a href="{guideurl}#{target}">{0={guideurl}{target}}</a>
+[wiki-inlinemacro]
+<a href="{wikiurl}{target}">{0={target}}</a>
 endif::backend-xhtml11[]
 
 [paradef-default]

Added: branches/new-help-system/base/doc/portundocumented.7
===================================================================
--- branches/new-help-system/base/doc/portundocumented.7	                        (rev 0)
+++ branches/new-help-system/base/doc/portundocumented.7	2012-12-15 03:51:18 UTC (rev 100548)
@@ -0,0 +1,102 @@
+'\" t
+.TH "PORTUNDOCUMENTED" "7" "2012\-12\-15" "MacPorts 2\&.1\&.99" "MacPorts Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+portundocumented \- A last\-resort man page for missing MacPorts documentation
+.SH "DESCRIPTION"
+.sp
+Unfortunately, the requested topic is not yet documented in the MacPorts man pages\&. Sorry\&.
+.sp
+Further documentation on MacPorts can be found in the following places:
+.PP
+\m[blue]\fBThe MacPorts Guide\fR\m[]\&\s-2\u[1]\d\s+2
+.RS 4
+Detailed help and support guide
+.RE
+.PP
+\m[blue]\fBThe MacPorts Wiki\fR\m[]\&\s-2\u[2]\d\s+2
+.RS 4
+MacPorts usage, development, and support
+.RE
+.PP
+\m[blue]\fBMailing Lists\fR\m[]\&\s-2\u[3]\d\s+2
+.RS 4
+Ask questions on the mailing lists: macports\-dev for base and Portfile development, macports\-users for user support questions
+.RE
+.PP
+\m[blue]\fBFAQ\fR\m[]\&\s-2\u[4]\d\s+2
+.RS 4
+Frequently Asked Questions
+.RE
+.PP
+\m[blue]\fBProblem Hotlist\fR\m[]\&\s-2\u[5]\d\s+2
+.RS 4
+Solutions for the most common error messages and other problems
+.RE
+.SH "CONTRIBUTING"
+.sp
+All sort of contributions to MacPorts base, ports and especially the documentation you were just looking for are welcome\&. If you care about MacPorts and would like to improve our documentation, please take a look at the source code of the man pages \m[blue]\fBin our repository\fR\m[]\&\s-2\u[6]\d\s+2 and get in touch with us on our \m[blue]\fBmailing lists\fR\m[]\&\s-2\u[3]\d\s+2\&.
+.SH "SEE ALSO"
+.sp
+\fBport\fR(1)
+.SH "AUTHORS"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+(C) 2012 The MacPorts Project
+(C) 2012 Rainer Müller <raimue at macports\&.org>
+.fi
+.if n \{\
+.RE
+.\}
+.SH "EXTERNAL REFERENCES"
+.IP " 1." 4
+The MacPorts Guide
+.RS 4
+\%http://guide.macports.org/#
+.RE
+.IP " 2." 4
+The MacPorts Wiki
+.RS 4
+\%https://trac.macports.org/wiki/
+.RE
+.IP " 3." 4
+Mailing Lists
+.RS 4
+\%https://trac.macports.org/wiki/MailingLists
+.RE
+.IP " 4." 4
+FAQ
+.RS 4
+\%https://trac.macports.org/wiki/FAQ
+.RE
+.IP " 5." 4
+Problem Hotlist
+.RS 4
+\%https://trac.macports.org/wiki/ProblemHotlist
+.RE
+.IP " 6." 4
+in our repository
+.RS 4
+\%https://trac.macports.org/browser/trunk/base/doc
+.RE

Added: branches/new-help-system/base/doc/portundocumented.7.txt
===================================================================
--- branches/new-help-system/base/doc/portundocumented.7.txt	                        (rev 0)
+++ branches/new-help-system/base/doc/portundocumented.7.txt	2012-12-15 03:51:18 UTC (rev 100548)
@@ -0,0 +1,47 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+portundocumented(7)
+====================
+$Id$
+
+NAME
+----
+portundocumented - A last-resort man page for missing MacPorts documentation
+
+DESCRIPTION
+-----------
+Unfortunately, the requested topic is not yet documented in the MacPorts man
+pages. Sorry.
+
+Further documentation on MacPorts can be found in the following places:
+
+guide:[The MacPorts Guide]::
+    Detailed help and support guide
+wiki:[The MacPorts Wiki]::
+    MacPorts usage, development, and support
+wiki:MailingLists[Mailing Lists]::
+    Ask questions on the mailing lists:
+    macports-dev for base and Portfile development,
+    macports-users for user support questions
+wiki:FAQ[]::
+    Frequently Asked Questions
+wiki:ProblemHotlist[Problem Hotlist]::
+    Solutions for the most common error messages and other problems
+
+
+CONTRIBUTING
+------------
+All sort of contributions to MacPorts base, ports and especially the
+documentation you were just looking for are welcome. If you care about MacPorts
+and would like to improve our documentation, please take a look at the source
+code of the man pages https://trac.macports.org/browser/trunk/base/doc[in our
+repository] and get in touch with us on our wiki:MailingLists[mailing lists].
+
+
+SEE ALSO
+--------
+man:port[1]
+
+AUTHORS
+-------
+ (C) 2012 The MacPorts Project
+ (C) 2012 Rainer Müller <raimue at macports.org>


Property changes on: branches/new-help-system/base/doc/portundocumented.7.txt
___________________________________________________________________
Added: svn:keywords
   + Id
Added: svn:eol-style
   + native
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20121214/634e06b7/attachment.html>
