forked from superfeedr/subtome
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
319 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>Subtome - Developers</title> | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
<meta name="description" content=""> | ||
<meta name="author" content=""> | ||
<link href="src/bootstrap/css/bootstrap.css" rel="stylesheet"> | ||
<script src="src/jquery/jquery.js"></script> | ||
<script src="src/bootstrap/js/bootstrap.js"></script> | ||
<script src="/build/settings.subtome.js"></script> | ||
<style type="text/css"> | ||
body { | ||
padding-top: 20px; | ||
padding-bottom: 40px; | ||
} | ||
|
||
/* Custom container */ | ||
.container-narrow { | ||
margin: 0 auto; | ||
max-width: 700px; | ||
} | ||
.container-narrow > hr { | ||
margin: 30px 0; | ||
} | ||
|
||
</style> | ||
<link href="src/bootstrap/css/bootstrap-responsive.css" rel="stylesheet"> | ||
|
||
<!-- HTML5 shim, for IE6-8 support of HTML5 elements --> | ||
<!--[if lt IE 9]> | ||
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> | ||
<![endif]--> | ||
|
||
<!-- Fav and touch icons --> | ||
<link rel="shortcut icon" href="src/ico/favicon.ico"> | ||
</head> | ||
|
||
<body> | ||
|
||
<div class="container-narrow"> | ||
|
||
<div class="masthead"> | ||
<ul class="nav nav-pills pull-right"> | ||
<li><a href="/">Home</a></li> | ||
<li><a href="/settings.html">Settings</a></li> | ||
<li><a href="/publishers.html">Publishers</a></li> | ||
<li class="active" ><a href="/developers.html">Developers</a></li> | ||
<li><a href="https://github.com/superfeedr/subtome">Source Code</a></li> | ||
</ul> | ||
<h3 class="muted">Subtome</h3> | ||
</div> | ||
|
||
<hr> | ||
<h1>Developers</h1> | ||
<h2>Allow your users to subscribe to content</h2> | ||
<p> | ||
If your application is able to handle user subscriptions, this section is for you. | ||
</p> | ||
<h3>Registration</h3> | ||
<p> | ||
Your users will click on subscribe buttons on some <a href="/publishers.html">publisher</a> pages. When they do so, a | ||
list of the subscription services <em>they</em> used in the past is displayed. This list | ||
was not curated by us, but stored in their browser (using localStorage) from services that registered their ability to perform | ||
susbcriptions for that user. | ||
</p> | ||
<p>You too can quickly and easily register your application for your users by loading an iframe like this: | ||
<script src="https://gist.github.com/4333876.js"></script> | ||
Please note that this is completely transparent for the user! | ||
</p> | ||
<p>The <code>name</code> query string is the name of your application and the <code>url</code> is the url of the hander which will | ||
be called in your application to perform a susbcription. This url should include a <code>{url}</code> placeholder where the url of the document on which the subscribe button was clicked will be placed. | ||
<h3>Subscription handling</h3> | ||
|
||
<p>When a user clicks on a Subtome button, he can pick his favorite subscription application. If it's yours, then, a new browser tab will be created and will point to your application's handler <code>url</code> (see previous section). Based on the <code>url</code> you've provided, | ||
you will be able to extract the location of the page on which the button was clicked.</p> | ||
<p> | ||
Your application should then, perform the subscription, by extracting the content it needs. We recomand using the RSS/Atom feeds, but you could also very well extract the links to a Twitter profile for example allow the user to follow that profile. Possibilities are endless. | ||
</p> | ||
<hr> | ||
|
||
<div class="footer"> | ||
<p>© Superfeedr 2012</p> | ||
</div> | ||
|
||
</div> <!-- /container --> | ||
|
||
<script src="src/jquery/jquery.js"></script> | ||
<script src="src/bootstrap/js/bootstrap.js"></script> | ||
|
||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.