Skip to content

Commit ba68f0a

Browse files
committed
2016 Version for pH7 Nav Doc!
1 parent 0b76df1 commit ba68f0a

98 files changed

Lines changed: 5351 additions & 122 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGES

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
---------- V2 ----------
2-
This version requires a Web server that supports URL rewriting (As Apache, ...).
3-
Includes a complete rewrite of url with language support.
4-
A better integration of template files.
5-
1+
---------- V2 ----------
2+
This version requires a Web server that supports URL rewriting (like Apache, ...).
3+
It includes a complete rewrite of URL with language support.
4+
A better integration of template files.
5+

LICENSE

Lines changed: 66 additions & 66 deletions
Large diffs are not rendered by default.

README

Lines changed: 0 additions & 34 deletions
This file was deleted.

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# pH7 Nav Doc
2+
3+
## Description
4+
5+
pH7 Nav Doc is a little and very simple script using simple PHP functions lets you easily **create beautiful multilingual documentation for your software** and It lets you add some documentation files very easily.
6+
7+
- It supports multilingual URL and highly optimized for SEO.
8+
9+
- The script allows you to internationalize your documentation thanks its multiple-languages documentation pages and by keeping an excellent SEO for your site.
10+
11+
- It provides an Ajax interface with jQuery.
12+
13+
- It supports also the highlighting programming code in your documentation thanks to [highlight.js](https://highlightjs.org).
14+
15+
16+
## Installation
17+
18+
No installation.
19+
Simply place your documentation files with the extension. Dwt in a language folder or create a new one with your language.
20+
21+
22+
## Server Requirements
23+
24+
----- Operating System -----
25+
Linux, BSD, Solaris, Windows or Mac
26+
27+
----- Web Server -----
28+
Apache, CGI, FastCGI, IIS or ISAPI
29+
30+
----- Application Server -----
31+
PHP 5.3.0 or higher.
32+
33+
## Who uses pH7 Nav Doc?
34+
35+
- [pH7CMS Doc](http://ph7cms.com/doc/)
36+
37+
38+
39+
## Author
40+
41+
Pierre-Henry Soria
42+
43+
44+
## Contact
45+
46+
Please contact me with any collaboration with me to develop this script and notify me of any bug reports.
47+
Contact me at: pierrehenrysoria [[ AT ]] gmail [[ D0T ]] com
48+
49+
50+
## License
51+
52+
CC-BY - http://creativecommons.org/licenses/by/3.0/

data/en/Untitled Document

Whitespace-only changes.

data/en/code.tpl

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<h1>You can even easily highlighting programming code!</h1>
2+
3+
<p class="italic underline">Example:</p>
4+
5+
<pre>
6+
<code class="php">
7+
class MyClass
8+
{
9+
const MY_CONSTANT = 'abcd';
10+
11+
/**
12+
* @param string $sVal
13+
* @return string Returns If the $sVal parameter is "abcd", returns "abcd", otherwise "zyxw".
14+
*/
15+
public function myMethod($sVal)
16+
{
17+
if ($sVal == 'abcd')
18+
return 'abcd';
19+
else
20+
return 'zyxw';
21+
}
22+
23+
}
24+
</code>

data/en/core/404-error.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h1>Page not found!</h1>
22
<p><strong>Sorry, we weren't able to find the page you requested.</strong></p>
3-
<p><strong><em>Suggestions, Go on:</em></strong></p>
3+
<p><strong><em>Suggestions:</em></strong></p>
44

55
<ul>
66
<li><a href="{site_url}" data-load="ajax">Main Page</a></li>

data/en/core/welcome.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<h1>Welcome to the &quot;{site_name}&quot; software documentation!</h1>
1+
<h1>Welcome to the &quot;{site_name}&quot; documentation!</h1>

data/fr/code.tpl

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<h1>Syntaxe de code dans votre doc</h1>
2+
<h3>Vous pouvez aussi appliquer la syntaxe colorisée de la plupart des langages de programmation</h3>
3+
4+
<p class="italic underline">Example:</p>
5+
6+
<pre>
7+
<code class="php">
8+
class MyClass
9+
{
10+
const MY_CONSTANT = 'abcd';
11+
12+
/**
13+
* @param string $sVal
14+
* @return string Returns If the $sVal parameter is "abcd", returns "abcd", otherwise "zyxw".
15+
*/
16+
public function myMethod($sVal)
17+
{
18+
if ($sVal == 'abcd')
19+
return 'abcd';
20+
else
21+
return 'zyxw';
22+
}
23+
24+
}
25+
</code>

data/fr/core/welcome.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<h1>Bienvenue sur la documentation du logiciel &laquo; {site_name} &raquo; !</h1>
1+
<h1>Bienvenue sur la documentation de &laquo; {site_name} &raquo; !</h1>

0 commit comments

Comments
 (0)