Mercurial > web-octave
changeset 78:5fc2af501316 kai
Overhauled support and missing function page.
| author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
|---|---|
| date | Thu, 13 Oct 2016 17:55:06 +0200 |
| parents | 8697f27c627c |
| children | 4e0675ad8c98 |
| files | missing.md support-expectations.md support.md |
| diffstat | 3 files changed, 106 insertions(+), 152 deletions(-) [+] |
line wrap: on
line diff
--- a/missing.md Thu Oct 13 17:54:34 2016 +0200 +++ b/missing.md Thu Oct 13 17:55:06 2016 +0200 @@ -4,38 +4,33 @@ menu: false --- -GNU Octave strives to be among the very best numerical tools -available. While compatibility with Matlab is one of many strong -features of Octave, we have not achieved 100% compatibility. If -you are reading this page, it is most likely because you attempted -to use a function that is part of core Matlab, but has yet to be -implemented in Octave. +GNU Octave strives to be among the very best numerical tools available. +While compatibility with Matlab is one of many strong features of Octave, +we have not achieved 100% compatibility. +If you are reading this page, it is most likely because you attempted to +use a function that is part of core Matlab, but has yet to be implemented +in Octave. -There can be several reasons for the given function not to exist -in Octave: +There can be several reasons for the given function not to exist in Octave: + +- The function may exist in [Octave-Forge][1], but has not yet been adopted + as a part of the core Octave distribution. You can try to look for your + function in the [alphabetical list of functions][2] at the Octave-Forge + web site to see if it is available in some package. -<ul> - <li> - The function may exist - in <a href="http://octave.sourceforge.net">Octave-Forge</a>, but - has not yet been adopted as a part of the core Octave - distribution. You can try to look for your function in - the <a href="http://octave.sourceforge.net/functions_by_alpha.php">alphabetical - list of functions</a> at the Octave-Forge web site to see if it - is available in some package. - </li> - <li> - The function may be new to Matlab. It is possible that the Octave - community simply does not know it exists. Should this be the case, - feel free to open a feature request in the - <a href="http://bugs.octave.org">Octave bug tracker</a>. - </li> -</ul> +- The function may be new to Matlab. It is possible that the Octave + community simply does not know it exists. Should this be the case, + feel free to open a feature request in the [Octave bug tracker][3]. -The Octave community consists of volunteers working in their spare -time. As a result, development might sometimes not be fast enough for -your needs. If you have a feature request for Octave, the best way to -ensure that your suggested improvement gets incorporated is either to -implement the feature yourself or to pay somebody to do it for you. +The Octave community consists of volunteers working in their spare time. +As a result, development might sometimes not be fast enough for your needs. +If you have a feature request for Octave, the best way to ensure that your +suggested improvement gets incorporated is either to implement the feature +yourself or to pay somebody to do it for you. If you are interested in funding work on Octave, please check out -the <a href="get-involved.html">resources for developers</a>. +the [resources for developers][4]. + +[1]: http://octave.sourceforge.net +[2]: http://octave.sourceforge.net/functions_by_alpha.php +[3]: http://savannah.gnu.org/bugs/?group=octave +[4]: {{ "get-involved.html" | relative_url }}
--- a/support-expectations.md Thu Oct 13 17:54:34 2016 +0200 +++ b/support-expectations.md Thu Oct 13 17:55:06 2016 +0200 @@ -1,7 +1,7 @@ --- layout: default title: Support Expectations -menu: true +menu: false --- Octave is a capable free software system for numerical computing @@ -22,7 +22,7 @@ for help are ignored. -## Development Group +# Development Group People sometimes think that Octave is developed by some large team of well-paid programmers. Nothing could be further from the truth. @@ -30,17 +30,19 @@ over several years. Since then, there have been at most a half-dozen or so volunteers working on Octave at any one time. You can see who has done most of the work by looking through the -[development history](http://hg.savannah.gnu.org/hgweb/octave) -(prior to February 2008 it is best to look in the old `ChangeLog` files). -Currently, none of the Octave developers are paid to work on Octave directly. +[development history][1] (prior to February 2008 it is best to look +in the old `ChangeLog` files). Currently, none of the Octave developers +are paid to work on Octave directly. If you would like to see Octave moving forward more quickly, then contribute to its development, either by working on the project yourself, or by donating funds. With sufficient funding, we would be able to pay a few developers to work on Octave full time. +[1]: http://hg.savannah.gnu.org/hgweb/octave -## Help + +# Help When asking for help on the mailing list or IRC channel, or reporting a bug, remember that the people helping you @@ -49,24 +51,26 @@ Try to ask clear questions. Be precise about the problems you are having. -## Bugs +# Bugs No software is perfect, and Octave is no exception. -You can search the list of bug reports to see what -problems have been reported. In looking at the list, -you might also noticed the number of problems that have been *fixed*. +You can search the list of bug reports to see what problems have been reported. +In looking at the list, you might also noticed the number of problems that +have been *fixed*. Nearly all of these problems have been fixed by volunteers. -If you find a problem, you are encouraged to -[report it]({{ "/bugs.html" | relative_url }}). -Your report can help to improve Octave, -but you should not think of the bug tracker as your personal support line. +If you find a problem, you are encouraged to [report it][2]. +Your report can help to improve Octave, but you should not think of the bug +tracker as your personal support line. If you depend on Octave and absolutely must have prompt responses to problem reports, you should consider paying -for [commercial support][]. +for [commercial support][3]. + +[2]: {{ "bugs.html" | relative_url }} +[3]: {{ "commercial-support.html" | relative_url }} -## Features +# Features When we say that Octave is "mostly compatible" with Matlab, we mean that the language that it accepts is similar enough that a @@ -80,27 +84,14 @@ In most cases, Octave has the features that it does because -someone decided to add them becuase they needed them. If you have +someone decided to add them because they needed them. If you have the programming skills perhaps you can add the features you need. If you not, then consider paying for someone to implement the -feature for you. Most people who provide [commercial support][] -services for Octave will also take on custom programming projets. - +feature for you. Most people who provide [commercial support][3] +services for Octave will also take on custom programming projects. Even if you don't have the expertise required to implement new features or can't pay for someone to do the work for you, you may submit feature requests to the bug tracker. But you should understand that unless you are paying for someone to to add the feature, no one is obligated to do it for you. - - -## Releases - -The Octave project currently provides source releases only. -We simply don't have the volunteer resources to provide executable -versions of Octave packaged for different types of systems. -If you'd like to see this situation change, volunteer to help us, -or donate to the project so that an Octave developer can spend the -time needed to do the job. - -[commercial support]: {{ "/commercial-support.html" | relative_url }}
--- a/support.md Thu Oct 13 17:54:34 2016 +0200 +++ b/support.md Thu Oct 13 17:55:06 2016 +0200 @@ -6,111 +6,79 @@ If you need help using Octave, you have many options, from reading the Octave manual, asking for help on the mailing lists, chatting -online with other Octave users, or paying for commercial support. - - -## Support Expectations +online with other Octave users, or paying for [commercial support][1]. The Octave community is a loosely organized association of volunteers. Your interactions with the community will be better -if you have the <a href="support-expectations.html">right -expectations about the support options</a> available to you. +if you have the [right expectations about the support options][2] +available to you. + +[1]: {{ "commercial-support.html" | relative_url }} +[2]: {{ "support-expectations.html" | relative_url }} -## Commercial Support +# Reference Manual + +There is an [online HTML][3] and [PDF][4] version of the comprehensive +~800 page manual. This full documentation of Octave is generated directly +from the Texinfo source files that are distributed along with every copy of +the Octave source code. The complete text of the manual is also available +at the Octave prompt using the `doc` command. -Community support can be great, and with the Octave community it -often is, but sometimes you need to know that your question will -be answered. We maintain a <a href="commercial-support.html">list -of people and organizations who offer commercial support -contracts</a> for Octave. This list is available as a service to -the community and the support providers. The Octave project does -not provide endorsements or recommendations. +A printed version of the Octave manual may be ordered from +[Network Theory, Ltd.][5]. Any money raised from the sale of this book +will support the development of free software. For each copy sold $1 +will be donated to the GNU Octave Development Fund. - -## User Community - -There is an active user community centered around Octave. -<a href="support-expectations">Please understand</a> -that the people answering your question on the mailing list or IRC -channel, or helping to fix the bug you reported are doing so as -volunteers. +[3]: {{site.docs_url}} +[4]: http://www.octave.org/octave.pdf +[5]: http://www.network-theory.co.uk/octave/manual -## Documentation - -- __Reference Manual__: - Octave is fully documented by a comprehensive 800 page manual. +# Octave Wiki and FAQ - The on-line <a href="doc/interpreter/index.html">HTML</a> - and <a href="octave.pdf">PDF</a> versions of the manual are - generated directly from the Texinfo source files that are - distributed along with every copy of the Octave source code. The - complete text of the manual is also available at the Octave prompt - using the `doc` command. +The [Octave Wiki][6] is a great place to look for information about +things that are not covered in the manual, or other transient topics +(Google Summer of Code, Octave Conferences, etc.). - A printed version of the Octave manual may be ordered from - <a href="http://www.network-theory.co.uk/octave/manual">Network Theory, - Ltd.</a>. Any money raised from the sale of this book will - support the development of free software. For each copy sold $1 - will be donated to the GNU Octave Development Fund. +Additionally, the wiki contains a list of +[frequently asked questions (FAQ)][7] -- __Frequently Asked Questions__: - If you are new to Octave, you may have some - <a href="http://www.octave.org/wiki/FAQ">questions - that have been asked (and answered) a few times before.</a> - -- __Wiki__: - The <a href="http://wiki.octave.org">Octave Wiki</a> is a great - place to look for information about things that are not covered in - the manual, or other transient topics (Google Summer of Code, - Octave Conferences, etc.). +[6]: http://wiki.octave.org +[7]: http://wiki.octave.org/FAQ -## Contacting Other Users for Help +# Contacting the user community -- __Mailing List__: +- **Mailing List**: If your question isn't answered in the FAQ, the manual, or the Wiki, - the <a href="mailto:help@octave.org">help@octave.org</a> mailing - list is a good resource. + the [`help@octave.org`][8] mailing list is a good resource. - <div id="search-form"> - <table> - <tr> - <td> - <form action="http://octave.1599824.n4.nabble.com/template/NamlServlet.jtp"><input type="hidden" name="macro" value="search_page" /> - <input type="hidden" name="node" value="1599825" /> - <input id="query" name="query" size="25" /> - <select name="days"> - <option value="0" selected>all dates</option> - <option value="1">past 24 hours</option> - <option value="7">past week</option> - <option value="30">past month</option> - <option value="90">past 3 months</option> - <option value="180">past 6 months</option> - <option value="365">past year</option> - </select> - <input type="submit" value="Search" /> - </form> - </td> - </tr> - <tr> - <td> - <a href="http://octave.1599824.n4.nabble.com/template/NamlServlet.jtp?macro=adv_search_page&node=1599825">Advanced Search</a> - </tr> - <tr> - <td> - <a href="https://lists.gnu.org/mailman/listinfo/help-octave">List - Info Page</a> (subscribe here) - </td> - </tr> - </table> - </div> + You can also [subscribe][9] to `help@octave.org` or try to search in the + mailing list archive for an answer: + <form action="http://octave.1599824.n4.nabble.com/template/NamlServlet.jtp"> + <input type="hidden" name="macro" value="search_page" /> + <input type="hidden" name="node" value="1599825" /> + <input id="query" name="query" size="25" /> + <select name="days"> + <option value="0" selected>all dates</option> + <option value="1">past 24 hours</option> + <option value="7">past week</option> + <option value="30">past month</option> + <option value="90">past 3 months</option> + <option value="180">past 6 months</option> + <option value="365">past year</option> + </select> + <input type="submit" value="Search" /> + </form> -- __Chat__: +- **IRC Chat**: Too impatient for email? You can find Octave developers and users on the - <a href="http://webchat.freenode.net/?channels=octave&uio=MT1mYWxzZSYyPXRydWUmMTI9dHJ1ZQda"><code>#octave</code> - channel</a> - at <a href="http://freenode.net"><code>irc.freenode.net</code></a>. - The atmosphere is relaxed and chat isn't restricted to matters - strictly pertaining to Octave. + [`#octave` channel][10] at [`irc.freenode.net`][11]. + The atmosphere is relaxed and chat isn't restricted to matters strictly + pertaining to Octave. + +[8]: mailto:help@octave.org +[9]: https://lists.gnu.org/mailman/listinfo/help-octave +[10]: http://webchat.freenode.net/?channels=octave&uio=MT1mYWxzZSYyPXRydWUmMTI9dHJ1ZQda +[11]: http://freenode.net