-
Notifications
You must be signed in to change notification settings - Fork 5
/
readme.html
154 lines (140 loc) · 10.2 KB
/
readme.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Sales Report II</title>
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.css">
<style>
#navbar-contents {
z-index: -1;
position: static;
}
#main-container {
padding-top: 120px;
}
@media (min-width: 768px) {
#navbar-contents {
position: fixed;
z-index: initial;
max-width: 200px;
}
}
@media (min-width: 992px) {
#navbar-contents {
max-width: 300px;
}
}
.nav-pills .nav-link.active {
background-color: #6e7581;
}
</style>
</head>
<body data-bs-spy="scroll" data-bs-target="#navbar-contents" data-bs-offset="100">
<header>
<nav id="navbar-header" class="navbar position-fixed navbar-light bg-light shadow-sm justify-content-center align-items-center container-fluid py-3">
<div class="container">
<h1 class="mb-1 fs-4">Zen Cart Sales Report II</h1>
<div class="float-md-right text-center text-md-right mt-2 mt-md-0">
<i class="bi-github me-1 align-top"></i> <a href="https://github.com/lat9/sales_report" target="_blank" class="link-secondary text-decoration-none me-4">GitHub Repository</a>
<i class="bi-layout-text-sidebar-reverse me-1 align-top"></i> <a href="https://www.zen-cart.com/forum/showthread.php?p=253173" target="_blank" class="link-secondary text-decoration-none">Support Thread</a>
</div>
</div>
</nav>
</header>
<div class="container mb-5" id="main-container">
<div class="row">
<aside class="col-md-4 col-xxl-3">
<nav id="navbar-contents" class="navbar navbar-light bg-light flex-column align-items-stretch p-3 shadow-sm mt-4 mt-sm-3 mb-3 my-md-0">
<nav class="nav nav-pills flex-column">
<a class="nav-link link-secondary" href="#item-introduction">Introduction</a>
<nav class="nav nav-pills flex-column">
<a class="nav-link link-secondary ms-3 my-1" href="#item-credits">History and Credits</a>
</nav>
<a class="nav-link link-secondary" href="#item-prerequisites">Prerequisites</a>
<a class="nav-link link-secondary" href="#item-installation">Installation</a>
<a class="nav-link link-secondary" href="#item-usage">Usage</a>
<a class="nav-link link-secondary" href="#item-uninstall">Uninstall</a>
<a class="nav-link link-secondary" href="#item-faq">Frequently Asked Questions</a>
<a class="nav-link link-secondary" href="#item-files-list">Files List</a>
<a class="nav-link link-secondary" href="#item-changelog">Change History</a>
</nav>
</nav>
</aside>
<article class="col-md-8 col-xxl-9 mt-4 mt-md-0 ps-md-4">
<section>
<h1 id="item-introduction" class="display-1 fs-2 pb-2">Introduction</h1>
<p>This report was originally designed to offer professional-level accounting data for businesses who use Zen Cart heavily, with multiple display options, several levels of data output and flexible search options. It has been tested in a Zen Cart shop with 116,000 orders. If it works for them, it should work for you.</p>
<p>Its features are explained in the <a href="https://github.com/lat9/sales_report/wiki/Report-generation-Options" target="_blank">report's wiki</a>, but the report has been built with usability in mind, even for the most simplistic of users. Using the report should be fairly obvious and self-explanatory, but please let me know if you feel something can be tweaked/added/removed to offer a more user-friendly experience.</p>
<h2 id="item-credits" class="fs-4 pt-1 pb-3">History and Credits</h2>
<p>This report is based on v3.5.1 of the <em>Sales Report</em> authored by Frank Koehl (PM: BlindSide), Conor Kerr Ceon, Carl Peach, Cindy Merkin (lat9) and Scott C. Wilson (swguy). See this distribution's <code>readme.txt</code> for previous modifications.</p>
<p>This readme's formatting based on that originally developed by <a href="https://github.com/marco-pm" _target="blank">@marco-pm</a>.</p>
</section>
<section>
<h1 id="item-prerequisites" class="display-1 fs-2 pb-2 pt-4">Prerequisites</h1>
<ul class="mt-3">
<li>A Zen Cart installation, v1.5.8 or later.</li>
<li class="mt-1">PHP 7.3 through 8.3</li>
<li class="mt-1">Javascript must be enabled in your browser.</li>
</ul>
</section>
<section>
<h1 id="item-installation" class="display-1 fs-2 pb-2 pt-4">Installation</h1>
<p>Starting with v4.0.0, the report is released as a Zen Cart <em>encapsulated plugin</em>, so installation (and removal) is simplified.</p>
<ol>
<li><em>Merge</em> the plugin's <code>/zc_plugins</code> with your site's pre-existing <code>/zc_plugins</code> directory.</li>
<li>Log into your Zen Cart admin panel.</li>
<li>Use the admin menus, navigating to <em>Modules :: Plugin Manager</em>.</li>
<li>You'll see a plugin named <b>Sales Report II</b>; click the <em>Install</em> button for the plugin. That's it!</li>
</ol>
</section>
<section>
<h1 id="item-usage" class="display-1 fs-2 pb-2 pt-4">Usage</h1>
<p>Once you've installed the report, you will see an addition to the admin's <em>Reports</em> main menu tab named <em>Sales Report II</em>; click that menu item and start generating reports.</p>
</section>
<section>
<h1 id="item-uninstall" class="display-1 fs-2 pb-2 pt-4">Uninstall</h1>
<p>To uninstall the report, navigate to the admin's <em>Modules :: Plugin Manager</em>, find the line-item for <em>Sales Report II</em> and click the <em>Un-Install</em> button.</p>
</section>
<section>
<h1 id="item-faq" class="display-1 fs-2 mt-6 pb-2 pt-4">Frequently Asked Questions</h1>
<p>See the report's <a href="https://github.com/lat9/sales_report/wiki/Frequently-Asked-Questions" target="_blanks">online wiki.</a></p>
</section>
<section>
<h1 id="item-files-list" class="display-1 fs-2 pb-2 pt-4">Files List</h1>
<p>The report provides the following files in its <span class="font-monospace">/zc_plugins/SalesReport/v4.0.1</span> directory:</p>
<ul class="mt-2 text-break">
<li><span class="font-monospace">/admin/stats_sales_report2.php</span></li>
<li><span class="font-monospace">/admin/includes/classes/sales_report2.php</span></li>
<li><span class="font-monospace">/admin/includes/css/stats_sales_report2.css</span></li>
<li><span class="font-monospace">/admin/includes/extra_datafiles/sales_report2_filenames.php</span></li>
<li><span class="font-monospace">/admin/includes/javascript/stats_sales_report2.php</span></li>
<li><span class="font-monospace">/admin/includes/languages/english/lang.stats_sales_report2.php</span></li>
<li><span class="font-monospace">/admin/includes/languages/english/extra_definitions/lang.sales_report2_menu_name.php</span></li>
</ul>
</section>
<section>
<h1 id="item-changelog" class="display-1 fs-2 pb-2 pt-4">Change History</h1>
<p>You can view the details of these changes on the report's <a href="https://github.com/lat9/sales_report" target="_blank" class="link-secondary">GitHub repository</a>.</p>
<ul>
<li>v4.0.1, 2024-06-01 (lat9):<ul>
<li>BUGFIX: Correct HTML class name in report.</li>
</ul></li>
<li>v4.0.0, 2023-04-30 (lat9):<ul>
<li>CHANGE: Migrate the previous report to use the structure of a Zen Cart <em>encapsulated plugin</em>.</li>
<li>BUGFIX: Correct "Timeframe Statistics" output when products with attributes are present.</li>
<li>CHANGE: Add "Last 12 Months" as a report preset date-range.</li>
<li>CHANGE: Use the "datepicker" instead of "spiffyCal" for custom date ranges.</li>
<li>CHANGE: The <code>DISPLAY_EMPTY_TIMEFRAMES</code> setting is now reversed; <var>(bool)false</var> now means that empty timeframes are not displayed.</li>
<li>CHANGE: Enable additional discount- or surcharge-adding order-totals to be included without modification to the base report.</li>
<li>CHANGE: Enable optional inclusion of customer's email-address when displaying <em>orders</em> information.</li>
</ul></li>
</ul>
</section>
</article>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" crossorigin="anonymous"></script>
</body>
</html>