You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DocumentationStandard.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -41,12 +41,12 @@ SeLite doesn't use GitHub Wiki, which doesn't utilise screen well, especially on
41
41
*`gem install link-checker` and `check-links _site` (not maintained since v. 0.7.2, Oct 2012; it reports broken external links but not broken local links). Don't use `html-proofer` gem and its `htmlproof` command (since it doesn't like GitHub-based relative links).
42
42
* Use online [W3 Link Checker](https://validator.w3.org/checklink). A faster way: run it locally with Jekyll 3.0 (or with `gem install jekyll --pre`):<br/> `wget http://search.cpan.org/CPAN/authors/id/S/SC/SCOP/W3C-LinkChecker-4.81.tar.gz`<br/> `sudo cpan -i Config::General Net::IP CSS::DOM`<br/> `tar xvzf W3C-LinkChecker-4.81.tar.gz; cd W3C-LinkChecker-4.81; perl Makefile.PL; make; sudo make install`<br/> `checklink --quiet --location http://localhost:4000/ http://localhost:4000/`
43
43
44
-
##Drawn diagrams
44
+
# Drawn diagrams
45
45
Don't use UML tools, as they are more restrictive and less efficient. <!-- That"s why I didn"t consider using e.g. http://plantuml.sourceforge.net and http://sourceforge.net/projects/plantumlnb -->
46
46
47
47
Draw diagrams in LibreOffice/OpenOffice and save them as `.odg`. Then Edit > Select All; File > Export (export the selection, rather than the whole drawing area). Export as a .png, not interlaced, with lowest compression. Then commit both .odg and .png to git. In documentation use URLs of 'Raw' images from git (e.g. [selite/diagrams/](https://github.com/selite/selite/tree/master/diagrams) > navigate to `.png` file > get URL of 'Raw' button).
48
48
49
-
###Versions of LibreOffice
49
+
## Versions of LibreOffice
50
50
* LibreOffice version that came with CentOS 6.4 didn't export as `.png` well - the quality was low.
51
51
* CentOS 6.5 has LibreOffice 4.0.4.2, which is better than one from CentOS 6.4, but it still doesn't export very well.
52
52
* LibreOffice 4.1.3.2 that came with Fedora 19 KDE worked well.
* use colours black, Chart 11 for red, Green 4, Chart 12 for blue, Chart 3 for yellow
59
59
60
-
##Textual object diagrams
60
+
# Textual object diagrams
61
61
Object Diagrams draw ownership/reference relationships between objects, fields and functions. They usually don't necessarily describe class inheritance (which is clear from the source and from [API]).
62
62
63
63
Text diagrams don't need to be esthetic, but clear and easy to edit - so you can quickly update them whenever you change the relevant code. They are in plain text, with **`<, >, ^, v`** for connections. The diagrams look like this:
@@ -76,15 +76,15 @@ Below the object constructor name are object fields. Indent them with two spaces
76
76
but rather as a value of a defined constant.
77
77
~~~
78
78
79
-
##Headers IDs must be the same as their text
79
+
# Headers IDs must be the same as their text
80
80
Don't use [Kramdown-specific header IDs](http://kramdown.gettalong.org/syntax.html#specifying-a-header-id), since they don't work in Markdown Viewer in Firefox..
81
81
82
-
##Generating raw links
82
+
# Generating raw links
83
83
GitHub doesn't serve raw versions of most file types with their MIME, except for images. So we use [htmlpreview.github.io](http://htmlpreview.github.io) for `.html` files. For any other files, e.g. `.xml, .xsl` or `.js`, use [rawgit.com](http://rawgit.com).
84
84
85
85
In detail: Use _htmlpreview.github.io_ rather than _rawgit.com_ for `.html`, because if you pass a generic Github URL (rather than a commit hash or a tag), _htmlpreview.github.io_ fetches the latest commit of that file. Therefore we don't have to update those _htmlpreview.github.io_ links. However, production _cdn.rawgit.com_ caches the files. If you change e.g. `component's-name/src/chrome/content/reference.xml` or `extension-sequencer/src/chrome/content/selenese_reference_to_html.xsl`, then update its _cdn.rawgit.com_ URLs to use the new commit hash or tag.
86
86
87
-
###Updating links to cdn.rawgit.com
87
+
## Updating links to cdn.rawgit.com
88
88
The most difficult part is to locate the 'Raw' link (on GitHub) for a chosen commit.
89
89
90
90
* Locating by commit first: Navigate to [github.com/selite/selite](https://github.com/selite/selite) > 'latest commit XYZ...' link near middle top > 'Browse files' button near the right top > locate the file > 'Raw' button.
Copy file name to clipboardExpand all lines: ReportingIssues.md
+4-1
Original file line number
Diff line number
Diff line change
@@ -46,4 +46,7 @@ Do not just attach screenshots that just show messages or your command(s). Also
46
46
## Submit your Firefox profile ##
47
47
If the problem only happens with third party or custom extensions, or if it involves a complex situation, you may need to attach your Firefox profile. See also [TroubleShooting](TroubleShooting) > [Separate Firefox profile](TroubleShooting#separate-firefox-profile). [Locate the Firefox profile](https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data#w_how-do-i-find-my-profile) folder. Turn Firefox off, remove any [private data](https://support.mozilla.org/en-US/kb/recovering-important-data-from-an-old-profile#w_your-important-data-and-their-files) and `places.sqlite`.
48
48
49
-
However, GitHub doesn't allow issue attachments other than images. So, zip up the folder, upload it to somewhere on the internet and add a link to it to the issue. Alternatively, and only if the `.zip` file is under 10MB, email it to the maintainer.
49
+
However, GitHub doesn't allow issue attachments other than images. So, zip up the folder, upload it to somewhere on the internet and add a link to it to the issue. Alternatively, and only if the `.zip` file is under 10MB, email it to the maintainer.
50
+
51
+
# GitHub references
52
+
Please, refer to other issues, projects, forks, commits and pull requests with GitHub [Autolinked references and URLs](https://help.github.com/articles/autolinked-references-and-urls/).
0 commit comments